Skip to content

Markdown Support

Markdown Viewer supports the full GitHub-Flavored Markdown specification plus several extensions.

Standard Markdown

SyntaxSupport
Headings (# to ######)Auto-generated IDs for linking
Bold, italic, strikethrough**bold**, *italic*, ~~strike~~
LinksInternal .md links navigated in-app
ImagesClickable with lightbox overlay
BlockquotesStandard rendering
Ordered/unordered listsIncluding nested lists
Horizontal rules---, ***, ___
Inline codeBacktick syntax

GFM Extensions

FeatureSyntaxLibrary
TablesPipe syntaxBuilt-in GFM
Task lists- [x] / - [ ]Built-in GFM
Strikethrough~~text~~Built-in GFM
AutolinksURLs auto-linkedBuilt-in GFM

Plugin Extensions

GitHub Alerts

markdown
> [!NOTE]
> Informational note

> [!TIP]
> Helpful tip

> [!IMPORTANT]
> Important information

> [!WARNING]
> Warning message

> [!CAUTION]
> Caution notice

Footnotes

markdown
Text with a footnote reference[^1].

[^1]: The footnote content appears at the bottom.

Math (KaTeX)

Inline math: $E = mc^2$

Display math:

markdown
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Supports the full KaTeX function catalog.

Mermaid Diagrams

markdown
```mermaid
flowchart LR
    A --> B --> C
```

Supports all Mermaid diagram types: flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, Gantt charts, and more.

Diagrams include a fullscreen button. Syntax errors display the source code as fallback.

Syntax Highlighting

markdown
```python
def hello():
    print("Hello, world!")
```

Language detection is automatic when no language is specified. Supported languages include all highlight.js languages.

Extended Tables

Colspan via ||:

markdown
| Header 1 | Header 2 |
|---|---|
| This spans both columns ||

Smart Typography

InputOutput
"quotes"Curly double quotes
'quotes'Curly single quotes
don'tSmart apostrophe
---Em dash (—)
--En dash (–)
...Ellipsis (…)

Emoji Shortcodes

Use :name: syntax. Available shortcodes:

ShortcodeEmojiShortcodeEmoji
:rocket:🚀:heart:❤️
:fire:🔥:star:
:check::x:
:warning:⚠️:bulb:💡
:tada:🎉:sparkles:
:bug:🐛:gear:⚙️
:lock:🔒:shield:🛡️
:coffee::zap:

And 70+ more — see the full list in the source code.