What the viewer renders, and what enables it. See Markdown and the pipeline for how to build a pipeline.
Always on, whatever the pipeline.
| Syntax | Notes |
|---|---|
Headings, # and underlined |
Each gets a GitHub-style anchor and is listed in TableOfContents; can fold |
**bold**, *italic*, `code` |
|
Links and <https://…> autolinks |
Open with the platform's launcher, or raise LinkClicked |
| Images | Loaded in the background, sized to the viewer;  caps the size |
| Fenced and indented code blocks | Copy button, optional language, line numbers, wrapping; any language can render as your own control |
| Block quotes, ordered and unordered lists, thematic breaks | Tight and loose lists |
| Hard line breaks | \ or two spaces at the end of a line |
| HTML | <br> always; the HTML subset with the default pipeline |
Enabled by UseGitHubExtensions(), the pipeline of a viewer without one.
| Feature | Syntax |
|---|---|
| Strikethrough | ~~text~~ or ~text~, as on GitHub |
| Task lists | - [x] item; clickable with AreTaskListsInteractive |
| Pipe tables | \| col \| col \|; the context menu copies a table for a spreadsheet or as Markdown |
| Autolinks | Bare https://… addresses |
| Emoji shortcodes | :rocket: is 🚀; ASCII smileys such as :) stay as they are |
| Alerts | > [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION] |
| Footnotes | [^1] |
| CJK-friendly emphasis | Emphasis next to Chinese, Japanese and Korean punctuation |
| YAML front matter | A --- block at the top of the document, hidden |
| Details blocks | HTML <details> and <summary>; also UseHtmlDetails() on its own |
| HTML subset | <p align> and <div align> headers, <a><img></a> badges, <kbd>, <sub>, <sup>, <mark>, <b>, <code>, <hr>…; nothing runs, only <img> sources are fetched. Also UseHtmlSubset() on its own |
Added to a pipeline with the method shown, or with the viewer's shortcut of the same name where there is one (viewer.UseFigures()…).
| Feature | Method | Syntax |
|---|---|---|
| Foldable alerts and custom titles | UseExtendedAlertBlocks(), viewer.UseAlertBlocks() |
> [!NOTE] Custom title, > [!NOTE]- (collapsed), > [!NOTE]+ (expanded) |
| Thinking blocks | UseThinkingBlocks() |
A reasoning model's <think>…</think> |
| Abbreviations | UseAbbreviations() |
*[HTML]: HyperText Markup Language |
| Citations | UseCitations() |
""quoted text"" |
| Figures | UseFigures() |
^^^ blocks, ^^^ caption |
| Hard line breaks | UseHardlineBreaks() |
Every line break is a hard break |
| YouTube thumbnails | UseMediaLinks() |
 |
| Definition lists | UseDefinitionLists() |
Term, then : definition |
| Custom containers | UseCustomContainers() |
:::name … ::: blocks, ::text:: inline |
| Footers | UseFooters() |
^^ footer text |
| Smart punctuation | UseSmartyPants() |
"quotes", --, ---, ..., <<…>> become “ ” – — … « » |
| Letter and roman numeral lists | UseListExtras() |
a., A., i., I. |
| Style classes | UseGenericAttributes(), called last |
{.name} adds name to the element's style classes |
| Superscript, underline, highlight | UseEmphasisExtras() |
^text^, ++text++, ==text==; subscript ~text~ only without UseGitHubExtensions() |
| Grid tables | UseGridTables() |
RST-style grid tables |
| Feature | Package and method | Syntax |
|---|---|---|
| Syntax highlighting | SyntaxHighlighting, UseTextMateHighlighting() |
Fenced code blocks with a language |
| SVG images | Svg, UseSvg() |
, data:image/svg+xml |
| Mermaid diagrams | Mermaid, UseMermaid() |
```mermaid fences |
| Math | Math, UseMath() |
$…$, $$…$$, \(…\), \[…\] |