CommonMark

CommonMark is a Markdown dialect, an attempt to unify all the different, divergent dialects of Markdown by providing an unambiguous syntax specification for Markdown, together with a suite of comprehensive tests to validate implementation.

Time will show, if this attempt is successful.

However, CommonMark is a well specified Markdown dialect, in contrast to most (if not all) other dialects. Other software adopts CommonMark somehow, notably GitHub Flavored Markdown (GFM). But they provide proprietary extensions, which makes it harder to change to another CommonMark implementation if needed. Plus, they sometimes build on an older specification of CommonMark.

Zettelstore supports the latest CommonMark specification version 0.31.2 (2024-01-28). If possible, Zettelstore will adapt to newer versions when they are available.

To provide CommonMark support, Zettelstore uses currently the Goldmark implementation, which passes all validation tests of CommonMark. Effectively, Markdown and CommonMark are super-sets of HTML. Internally, CommonMark is translated into Zettelmarkup. Since Zettelmarkup supports HTML content only at the block level via Inline Zettel, most uses of HTML within a CommonMark zettel are not translated as expected. Instead, inline level HTML is translated into literal text with a generic attribute set to html.

Therefore, Zettelstore itself will not pass the CommonMark test suite fully. However, no CommonMark language element except inline HTML will fail to be encoded as HTML. In most cases, the differences are not visible for a user, but only by comparing the generated HTML code.