Markdown showcase

This document exercises supported Markdown and extensions. Use its generated HTML as a visual regression fixture while evolving the parser.

Headings

ATX heading level 1

ATX heading level 2

ATX heading level 3

ATX heading level 4

ATX heading level 5

ATX heading level 6

Closing ATX heading

Paragraphs and inline text

This paragraph contains emphasis, strong text, inline code, and a local link.

It also contains a reference link, a shortcut reference, direct image , referenced image , and *escaped emphasis*.

This is a soft-wrapped line. This line follows it without a hard break.

This line ends with a hard break.
This line follows it.

This line ends with two spaces. This line follows it.

Thematic break

Lists

• First unordered item
• Second unordered item
  • Nested unordered item
  • Another nested item
    1. Nested ordered item
    2. Another nested ordered item
• Plus-marked unordered item
• Asterisk-marked unordered item

7. Ordered list starting at seven
8. Second ordered item
9. Third ordered item

• Bold item with italic text, inline code, and a link.
• Bold item with inline code.
• Italic item with nested bold and inline code.
• Code with bold text and italic text.
• C (c): a bold label containing inline code.

• VSCodium / VS Code

  • File History Navigation
    Browser-style Back and Forward navigation between files.

• Setext heading in a list item

• A thematic break in a list item follows.

  ---

• A block quote can contain paragraphs and nested quotes.

  First paragraph

  Second paragraph

  Nested quote

Block quotes

A block quote with strong text and inline code.

A second quoted paragraph.

Outer quote

Nested quote

Code blocks

Indented code block
with two lines

printf '%s\n' 'Fenced code block'

Tilde-fenced code block.

Long fenced code block.

HTML

Inline HTML, an HTML entity &, normal &, and a comment follow.

Extensions

Common extensions

These extensions are supported by GitHub, Codeberg, and the VSCodium Markdown preview, so they are considered pretty common.

Double tildes strikethrough.

Jump to headings and heading identifiers provide anchor support.

Automatic link: https://example.com and https://example.com.

Email automatic link: hello@example.com.

Footnotes can provide supporting detail.¹

Emoji shortcodes: 🚀 ✨ ✅

Diagrams

E.g. flowcharts

flowchart LR
    Markdown --> HTML
    HTML --> Diagram

or sequence diagrams

sequenceDiagram
    MarkShup->>Mermaid: Diagram source
    Mermaid-->>Browser: SVG diagram

Less common extensions

These extensions are either not known to GitHub, Codeberg, or VSCodium, so they are considered less common.

Identified heading

Highlighted text.

• Incomplete task
• Completed task

Term

Definition list entry.

Single tildes strikethrough.

Note

An admonition or callout.

MarkShup extensions

These are convenience extensions introduced by MarkShup itself.

This is ~extra tildes strikethrough~.

H₂O and x¹⁰.