2.4 KiB
| template |
|---|
| overrides/main.html |
Footnotes
Footnotes are a great way to add references to supplemental or additional information for a specific section of a document without interrupting the document flow. Material for MkDocs provides the ability to insert inline footnotes and render them at the bottom of the page.
Configuration
Footnotes
:octicons-file-code-24: Source · :octicons-workflow-24: Extension
The Footnotes extension, which is part of the standard Markdown library,
adds the ability to add inline footnotes to a document and can be enabled via
mkdocs.yml:
markdown_extensions:
- footnotes
Usage
Adding footnote references
A footnote reference must be enclosed in square brackets and must start with a
caret ^, directly followed by an arbitrary identifier, which is similar to
the standard Markdown link syntax.
Example:
Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
Result:
Lorem ipsum1 dolor sit amet, consectetur adipiscing elit.2
Adding footnote content
The footnote content must be declared with the same identifier as the reference. It can be inserted at an arbitrary position in the document and is always rendered at the bottom of the page. Furthermore, a backlink to the footnote reference is automatically added.
on a single line
Short statements can be written on the same line.
Example:
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Result:
Jump to footnote at the bottom of the page
on multiple lines
Paragraphs can be written on the next line and must be indented by four spaces.
Example:
[^2]:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
Result: