-
-
Notifications
You must be signed in to change notification settings - Fork 214
Footnotes
Footnotes allow readers to quickly reference additional information without cluttering the main content.
Quarkdown introduces a compact [^label: definition] syntax which allows inlining footnote definitions directly in their reference:
This is a footnote reference[^first: This is the definition.],
and another one[^second: This is another definition.].
In case an inlined footnote does not need to be referenced anywhere else, the label may be omitted (anonymous footnote):
This is a footnote reference[^: This is the definition.],
and another one[^: This is another definition.].The definitions generated by named footnotes can be referenced again:
This is a footnote reference[^first: This is the definition],
and another one[^first].
Definitions can include inline formatting:
This is a footnote reference[^first: This is the **definition**.]
The 'standard' footnote syntax provided by many Markdown flavors is also supported.
This approach is more verbose but allows for a clean separation between the footnote reference and its definition, reducing clutter.
This is a footnote reference[^1].
[^1]: This is the definition.Inline formatting is also supported in the definition:
[^1]: This is the **definition**.Long definitions can be split across multiple lines. Indentation is not significant:
[^1]: This is
the definition.In case of multiple footnotes, make sure the definitions are separated by at least one blank line:
This is a footnote reference[^first], and another one[^second].
[^first]: This is the definition.
[^second]: This is another definition.Multiple references to the same footnote label are allowed, and they will all point to the same definition:
This is a footnote reference[^first], and another one[^first].
[^first]: This is the definition.The footnote label can be any string, and the definition can occur anywhere in the document:
[^first]: This is the definition.
This is a footnote reference[^first], and another one[^second].
[^second]: This is another definition.
Footnotes are numbered by default with decimal numbers, starting from 1.
To apply a different numbering style, such as Roman numerals,
the .numbering function can be used:
.numbering
- footnotes: i
See Numbering for more information about numbering.
Footnotes are numbered incrementally across the document. Page-level numbering is not supported yet.
Footnotes are rendered differently depending on the document type. See Document types to learn more.
- Figures
- Image size
- TeX formulae
- Table caption
- Code caption
- Decorative headings
- Alerts (quote types)
- Quotation source
- Cross-references
- Page breaks
- Text symbols (text replacement)
- Emojis
- Document metadata
- Theme
- CSS
- Fonts
- Page format
- Page margin content
- Page counter
- Persistent headings
- Automatic page break
- Numbering
- Paragraph style
- Caption position
- Table of contents
- Bibliography
- Footnotes
- Stacks (row, column, grid)
- Container
- Align
- Float
- Figure
- Clip
- Box
- Collapsible
- Landscape
- Whitespace
- Variables
- Optionality
- Math
- Conditional statements
- Loops
- Let
- Destructuring
- String manipulation
- Table manipulation: sorting, computing, and more
- Table generation
- String
- Number
- Markdown content
- Boolean
- None
- Enumeration entry
- Iterable
- Dictionary
- Range
- Lambda
- Size(s)
- Color
- Dynamic
- Paper: abstract, definitions, theorems, and more