What Markdown Unmarked renders

Unmarked renders CommonMark plus the GitHub extensions most files use: tables, task lists, strikethrough, and YAML frontmatter. Footnotes and math aren't rendered yet and show as plain text. The parser is Apple's swift-markdown.

Write standard Markdown and it renders. Here's the exact scope.

The full list of what renders

• Headings, levels 1 through 6
• Paragraphs and line breaks
• Bold, italic, and strikethrough
• Ordered, unordered, and nested lists
• Task lists, with checkboxes you can tick in Read mode
• Blockquotes
• Inline code
• Fenced code blocks, with a language label and a copy button
• Mermaid diagrams, from a fenced mermaid code block
• Links (clickable in Read mode)
• Local images
• Tables
• Horizontal rules
• YAML frontmatter, shown as a properties panel

That's CommonMark, the GitHub Flavored Markdown extensions you reach for most, and frontmatter. A file written for GitHub or for a static-site generator will look right.

A mermaid code block goes a step further: Unmarked draws it as a diagram in Read mode. See how Mermaid diagrams work in Unmarked.

What isn't rendered yet

Two things aren't styled yet:

• Footnotes ([^1]) appear as plain text.
• Math and LaTeX ($...$) appear as plain text.

Your footnotes and equations stay readable as source. Nothing is dropped or hidden. It just isn't formatted. For the full list of what Unmarked doesn't render yet, and why, see what's not rendered yet.

Remote images show as alt text

A https:// image link renders as its alt text, not the picture, because Unmarked has no network access to fetch it. A local image, like assets/diagram.png, renders normally. To make a web image show, save it locally and link it with a relative path.