Skip to article content

Footnotes use the standard Markdown syntax, including a numbered reference to the footnote in-line.

Footnote Definition Node Specification

Rich footnote content associated with footnote reference

type: string, (“footnoteDefinition”)
See also Node
children: array, (FlowContent)
See also Parent
identifier: string
See also OptionalAssociation
label: string, optional
See also OptionalAssociation
position: object, optional, (Position)
See also Node
data: object, optional
See also Node

Footnote Reference Node Specification

Inline reference to footnote

type: string, (“footnoteReference”)
See also Node
identifier: string
See also OptionalAssociation
label: string, optional
See also OptionalAssociation
position: object, optional, (Position)
See also Node
data: object, optional
See also Node

Footnote Node Example

Markup
AST
Render
Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.
Footnotes
  1. This is the first footnote.

  2. Here’s one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    { my code }

    Add as many paragraphs as you like.

MyST MarkdownMyST Markdown
Community-driven tools for the future of technical communication and publication