mirror of https://github.com/xoofx/markdig.git synced 2026-07-08 18:16:21 +00:00

Files

Alexandre Mutel 74f429c427 Add comprehensive documentation site

Create a full Lunet-based documentation site in site/ with:
- Site config, navigation, landing page with hero section
- Core docs: getting started, usage guide, CommonMark reference
- Extension docs: 19 pages covering all 30+ extensions
- Developer guide: AST, pipeline, creating extensions, block/inline
  parsers, renderers, performance
- API reference generation via lunet-io/templates
- Remove obsolete parsing-*.md files (content revised into docs/)
- Update AGENTS.md with website build instructions
- Add site/AGENTS.md with site-specific guidance

2026-02-21 23:50:30 +01:00

2.2 KiB

Raw Permalink Blame History

title

title
Footnotes

Footnotes

Enable with .UseFootnotes() (included in UseAdvancedExtensions()).

Footnotes allow you to add references that appear at the bottom of the document, inspired by PHP Markdown Extra.

Syntax

Define a footnote reference inline with [^label] and the footnote content elsewhere:

Here is a sentence with a footnote[^1].

And another with a named footnote[^note].

[^1]: This is the first footnote content.
[^note]: Footnotes can have any label, not just numbers.

Here is a sentence with a footnote¹.

And another with a named footnote².

Multi-line footnotes

Indent continuation lines to include multiple paragraphs in a footnote:

This has a long footnote[^long].

[^long]: This is the first paragraph of the footnote.

    This is the second paragraph. It must be indented to be
    included in the footnote.

    - Even lists work in footnotes
    - Like this one

This has a long footnote³.

Inline footnotes

You can also define footnotes inline (though this is less common):

This has an inline footnote^[This is the inline footnote content].

HTML output

Footnote references become superscript links, and footnote definitions are collected into a <section> at the end of the page:

<p>Text with a footnote<a href="#fn:1" class="footnote-ref"><sup>1</sup></a>.</p>

<section class="footnotes">
  <ol>
    <li id="fn:1">
      <p>This is the footnote content.
        <a href="#fnref:1" class="footnote-back-ref">↩</a></p>
    </li>
  </ol>
</section>

Rules

Footnote labels are case-insensitive.
Footnote definitions can appear anywhere in the document — they are always rendered at the end.
Unused footnote definitions are not rendered.
Multiple references to the same footnote share the same content.

This is the first footnote content. ↩︎
Footnotes can have any label, not just numbers. ↩︎
This is the first paragraph of the footnote.

This is the second paragraph. It must be indented to be included in the footnote.
- Even lists work in footnotes
- Like this one
↩︎

2.2 KiB Raw Permalink Blame History