Footnotes are a great way to add supplemental or additional information to a specific word, phrase or sentence without interrupting the flow of a document. Material for MkDocs provides the ability to define, reference and render footnotes.
This configuration adds the ability to define inline footnotes, which are then rendered below all Markdown content of a document. Add the following lines to
See additional configuration options:
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.
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 footnotes can be written on the same line:
on multiple lines¶
Paragraphs can be written on the next line and must be indented by four spaces: