Markdown Subset
Supported block elements
| Element | Syntax |
|---|---|
| Headings | ## through ###### (H2–H6). H1 is the page title from frontmatter. |
| Paragraphs | Plain text separated by blank lines |
| Blockquotes | > quoted text |
| Fenced code blocks | ``` with language identifier |
| Ordered lists | 1. item |
| Unordered lists | - item |
| Task lists | - [x] done / - [ ] todo |
| Tables | GFM pipe tables |
| Horizontal rules | --- |
| Callouts | > [!TYPE] (NOTE, TIP, WARNING, DANGER, IMPORTANT) |
Supported inline elements
| Element | Syntax | Result |
|---|---|---|
| Bold | **text** |
text |
| Italic | *text* |
text |
| Strikethrough | ~~text~~ |
|
| Inline code | `code` |
code |
| Links | [text](url) |
linked text |
| Images |  |
rendered image |
Callout types
| Type | Purpose | Icon |
|---|---|---|
NOTE |
Informational context | Info |
TIP |
Helpful advice | Star |
WARNING |
Potential issues | Warning triangle |
DANGER |
Destructive or irreversible actions | Error |
IMPORTANT |
Key information not to be overlooked | Star |
Syntax:
> [!WARNING]
> This action cannot be undone.Sanctioned HTML tags
These HTML tags are allowed within Markdown content and will not be stripped by the sanitization pipeline:
| Tag | Purpose |
|---|---|
<details> |
Collapsible section wrapper |
<summary> |
Collapsible section title |
<kbd> |
Keyboard shortcut display |
<sub> |
Subscript text |
<sup> |
Superscript text |
Code block languages
Syntax highlighting is supported for these languages (via Shiki):
typescript, javascript, bash, shell, json, yaml, bicep, css, html, markdown, powershell, python, sql, xml, csharp, go, rust, java, dockerfile
Unsupported features
The following features are not supported and will be stripped or ignored:
| Feature | Reason |
|---|---|
| Footnotes | Not in CommonMark; inconsistent rendering |
| Math / LaTeX | Requires KaTeX/MathJax integration (not planned) |
| Raw HTML blocks | Security risk; bypass sanitization |
| Emoji shortcodes | Use actual Unicode emoji instead |
| Definition lists | Not in CommonMark or GFM |
| Abbreviations | Limited browser/editor support |
| Mermaid diagrams | Requires runtime JS; not supported by the rendering pipeline |
Last updated by Hub Docs TeamEdit this page