Markdown Features

This page shows every Markdown feature document2 renders, followed by GitHub syntax it does not render yet.

• Headings
• Text
• Lists
• Tables
• Blockquotes
• Links and Images
• Alerts
• Footnotes
• Emoji
• Math
• Mermaid
• Attributes
• Not Rendered Yet

Headings

Heading level 3

Heading level 4

Heading level 5

Heading level 6

A paragraph directly below a heading. Paragraphs are separated by a blank line, and a line break inside a paragraph is joined into the same line.

A line ending with two spaces
breaks here, and a line ending with a backslash
breaks here too.

Text

Text can be bold, italic, bold and italic, struck through, or inline code. Combine them: bold with code inside and italic with a link.

Special characters are escaped: *not italic*, 5 < 10, and © 2026.

The line above is a horizontal rule. So are the next two.

Lists

Unordered list:

• Apples
• Oranges
  • Navel
  • Blood
    • Moro
    • Tarocco
• Bananas

Ordered list:

1. Install the package.
2. Publish the configuration.
   1. Run php artisan vendor:publish.
   2. Edit config/example.php.
3. Clear the cache.

An ordered list that starts at 5:

5. Fifth
6. Sixth

Task list:

• Write the documentation
• Add code samples
• Review the design
  • Light mode
  • Dark mode

A list with paragraphs and code:

1. First step.

   This paragraph belongs to the first step.

   Shell

    1php artisan about
   

2. Second step.

Tables

A wide table:

A table with formatting inside cells:

Blockquotes

A blockquote with bold text and a link.

A blockquote with several paragraphs.

The second paragraph.

A nested blockquote.

A blockquote with a list:

• One
• Two

Links and Images

• An inline link: Laravel
• A link with a title: Laravel
• A link to another page in this version: Configuration
• A link to a section on this page: Tables
• A reference link: CommonMark
• An autolink: https://github.com/replworks-bot/document2-test-docs
• An angle-bracket autolink: https://commonmark.org
• An email autolink: hello@example.com

An image:

A linked image:

Alerts

An alert with more content:

 1Route::get('/', fn () => view('welcome'));

These stay plain blockquotes: a marker followed by text, and an unknown type.

[!NOTE] inline text after the marker

[!UNKNOWN] Unknown type.

Footnotes

Here is a sentence with a footnote.¹ A named footnote can hold several paragraphs.² The first footnote is referenced again here.¹

A reference without a definition stays as written: [^missing].

Emoji

Unicode emoji: 🚀 🎉 👍 ❤️ ✨ ✅ ❌ ⚠️ 💡 🇰🇷

GitHub custom emoji:

Shortcodes next to each other: ❤️🎉

These stay as written: :rocket: in code, x:rocket: after a letter, :ROCKET: in upper case, and :not_an_emoji:.

Math

Inline math \(E = mc^2\), \(\sqrt{3}\) with backticks, and \(a_{ij}\) with braces.

A display block:

\[ \sum_{i=1}^{n} i = \frac{n(n+1)}{2} \]

A math code block:

These stay as written: $5 and $10, the $user variable, a hash $2y$10$abc, and $x$ in code.

Mermaid

A flowchart:

graph LR
    Push --> Build --> Publish
    Build -->|failed| Log[Build Log]

A sequence diagram:

sequenceDiagram
    Author->>GitHub: push
    GitHub->>Hub: push event
    Hub-->>Author: Site published

Attributes

A paragraph with a class and an id.

A link with a class: Get started

Not Rendered Yet

GitHub renders the syntax below, but document2 does not have the extensions for it yet. It shows how each one appears today.

Collapsed section

Keyboard keys

Press Ctrl + C to copy.