Markdown Features¶

Copy page

Copy Markdown link View as Markdown Open in Mistral Le Chat Open in ChatGPT Open in Claude

This server supports rich Markdown with powerful extensions. See them all in action!

Headings¶

H1 Heading¶

H2 Heading¶

H3 Heading¶

H4 Heading¶

H5 Heading¶

H6 Heading¶

All headings automatically get: - Unique IDs for linking - Permalink icons on hover (🔗) - Table of contents entries

Text Formatting¶

Bold text using **bold**

Italic text using *italic*

Bold and italic using ***both***

~~Strikethrough~~ using ~~strikethrough~~

Lists¶

Unordered Lists¶

• Item 1
• Item 2
• Nested item 2.1
• Nested item 2.2
• Item 3

Ordered Lists¶

1. First item
2. Second item
3. Nested 2.1
4. Nested 2.2
5. Third item

Task Lists¶

• Completed task
• Another completed task
• Pending task
• Another pending task

Code Blocks¶

Inline Code¶

Use backticks for inline code like const x = 5;

Syntax Highlighted Blocks¶

Python example:

def fibonacci(n):
    """Calculate Fibonacci number."""
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

# Usage
result = fibonacci(10)
print(f"Fibonacci(10) = {result}")

JavaScript example:

// Async/await example
async function fetchData(url) {
    try {
        const response = await fetch(url);
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('Error:', error);
    }
}

Bash example:

# Docker deployment
docker build -t my-app .
docker run -p 8080:8080 my-app

# With environment variables
docker run \
  -e DEBUG=true \
  -e PORT=3000 \
  -p 3000:3000 \
  my-app

Tables¶

Tables are fully supported with automatic styling:

Table with Alignment¶

Links¶

Internal Links¶

Link to other pages: Quick Setup Guide

Link to sections: Back to Code Blocks

Link to a section on another page: Quick Setup Guide, top

How .md links are rewritten¶

In the rendered HTML view, links to Markdown files point at the rendered page. Only the file extension of the path is replaced; query string and #fragment are kept. Raw Markdown (.md URLs) and llms.txt are not rewritten.

Supported syntaxes: inline links, reference-style definitions, and href attributes in inline HTML anchors. Not supported: links with a title or with spaces/parentheses in the URL, autolinks, and other HTML attributes such as src. Code blocks are not skipped, so link syntax inside a fence is rewritten too.

Heading anchors¶

Headings get an id from Python-Markdown's toc extension. For anchors to match, remember:

• Lower-cased; punctuation (including ., (, ), ;, —) is removed; whitespace becomes -: 1. De drie app-rollen → #1-de-drie-app-rollen, Verkort stappenplan (TL;DR) → #verkort-stappenplan-tldr.
• Accents are stripped (Café → cafe); characters without an ASCII equivalent (CJK, most emoji) disappear.
• Duplicate headings get _1, _2 suffixes (GitHub uses -1, -2).
• Set an explicit id with {#my-id} on the heading line when you need a stable anchor.

External Links¶

Visit GitHub or Python.org

External links open in new tabs automatically in the navigation.

Blockquotes¶

This is a blockquote. It can span multiple lines.

And even multiple paragraphs!

Pro Tip: Blockquotes are great for callouts, tips, and warnings.

Horizontal Rules¶

Separate content with horizontal rules:

Like that one above!

Images¶

Images are automatically handled:

Images support: - PNG, JPG, GIF, SVG - Automatic sizing - Responsive layout - Lazy loading

Footnotes¶

You can add footnotes¹ to your documentation.

Another footnote² reference.

Definition Lists¶

Term 1

Definition of term 1

Term 2

Definition of term 2

Another definition for term 2

Abbreviations¶

The HTML specification is maintained by the W3C.

Advanced Features¶

Nested Lists with Code¶

1. First step

   print("Step 1")
   

2. Second step

   print("Step 2")
   

3. Third step

Mixed Content¶

You can mix bold, italic, code, and links in tables:

Escaping¶

Need to show literal markdown? Escape with backslash:

**Not bold**

`Not code`

[Not a link](url)

Special Characters¶

The server handles special characters correctly:

• En dash: –
• Em dash: —
• Ellipsis: …
• Quotes: "smart" 'quotes'
• Symbols: © ® ™
• Arrows: → ← ↑ ↓
• Math: ± × ÷ ≠ ≈
• Emojis: 🎉 🚀 ✅ ❌ 💡

What's Not Supported?¶

Currently not implemented: - Math equations (LaTeX) - Embedded videos - Custom HTML components - MDX-style components

Everything else from CommonMark and popular extensions is supported!

Next Steps¶

• Navigation Features - Learn about sidebar and topbar
• LLMs.txt Support - AI assistant integration
• Examples - See real-world examples