Markdown Notes and Footnotes

Contents

• Admonitions
• Footnotes
• Mixed Formatting Stress Test
• Authoring Note

This is part 3 of the Markdown rendering reference.

Series:

1. Basics
2. Blocks, code, tables, and HTML
3. Admonitions, footnotes, and mixed formatting (this post)

Admonitions

Rendered:

Admonitions are useful for callouts in docs and tutorials.

You can still use normal Markdown inside the block, including inline code.

Keep admonitions short so they stay scannable.

• Use note for neutral context
• Use tip for suggestions
• Use warning for risky actions

This is the short warn alias.

Make a backup of content/, .env, and admin credentials before larger changes.

This is a danger admonition for destructive or high-risk actions.

This is an error admonition for failures and broken states.

This is a neutral admonition style without a semantic color accent.

Source:

!!!note Quick note
    Admonitions are useful for callouts in docs and tutorials.

    You can still use normal Markdown inside the block, including `inline code`.

!!!tip Authoring tip
    Keep admonitions short so they stay scannable.

    - Use **note** for neutral context
    - Use **tip** for suggestions
    - Use **warning** for risky actions

!!!warn Warn
    This is the short `warn` alias.

!!!warning Before editing production
    Make a backup of `content/`, `.env`, and admin credentials before larger changes.

!!!danger Danger
    This is a danger admonition for destructive or high-risk actions.

!!!error Error
    This is an error admonition for failures and broken states.

!!!none None
    This is a neutral admonition style without a semantic color accent.

Footnotes

Rendered:

Footnotes are useful for extra context without interrupting flow.¹

Another footnote callout appears here.²

You can also reference the same footnote again.¹

Source:

Footnotes are useful for extra context without interrupting flow.[^rendering-note]

Another footnote callout appears here.[^second-note]

You can also reference the same footnote again.[^rendering-note]

[^rendering-note]: The renderer should output footnote references and a footnote section.
[^second-note]: This helps verify multiple references render correctly.

Mixed Formatting Stress Test

Rendered:

A quote with a table-like line | not a table | and a link followed by bold text, deleted text, and a footnote marker.³

Source:

> A quote with a table-like line `| not a table |` and a [link](https://example.com)
> followed by **bold text**, ~~deleted text~~, and a footnote marker.[^mixed]

[^mixed]: Extra note for the mixed-format blockquote example.

Authoring Note

When you create test content, keep examples short and focused. It is easier to spot rendering regressions when each example demonstrates one thing clearly and includes its source right below it.

Prev: Part 2: Blocks, code, tables, and HTML