Skip to content

Footnote Rules

Footnote after Punctuation

Alias: footnote-after-punctuation

Ensures that footnote references are placed after punctuation, not before.

Examples

Placing footnotes after punctuation. Before: 
Lorem[^1]. Ipsum[^2], doletes.
After: 
Lorem.[^1] Ipsum,[^2] doletes.
A footnote at the start of a task is not moved to after the punctuation Before: 
- [ ] [^1]: This is a footnote and a task.
- [ ] This is a footnote and a task that gets swapped with the punctuation[^2]!
[^2]: This footnote got modified
After: 
- [ ] [^1]: This is a footnote and a task.
- [ ] This is a footnote and a task that gets swapped with the punctuation![^2]
[^2]: This footnote got modified

Move Footnotes to the bottom

Alias: move-footnotes-to-the-bottom

Move all footnotes to the bottom of the document and makes sure they are sorted based on the order they are referenced in the file's body.

Examples

Moving footnotes to the bottom Before: 
Lorem ipsum, consectetur adipiscing elit. [^1] Donec dictum turpis quis ipsum pellentesque.

[^1]: first footnote

Quisque lorem est, fringilla sed enim at, sollicitudin lacinia nisi.[^2]
[^2]: second footnote

Maecenas malesuada dignissim purus ac volutpat.
After: 
Lorem ipsum, consectetur adipiscing elit. [^1] Donec dictum turpis quis ipsum pellentesque.

Quisque lorem est, fringilla sed enim at, sollicitudin lacinia nisi.[^2]
Maecenas malesuada dignissim purus ac volutpat.

[^1]: first footnote
[^2]: second footnote

Re-Index Footnotes

Alias: re-index-footnotes

Re-indexes footnote keys and footnote, based on the order of occurrence. Note: This rule does not work if there is more than one footnote for a key.

Examples

Re-indexing footnotes after having deleted previous footnotes Before: 
Lorem ipsum at aliquet felis.[^3] Donec dictum turpis quis pellentesque,[^5] et iaculis tortor condimentum.

[^3]: first footnote
[^5]: second footnote
After: 
Lorem ipsum at aliquet felis.[^1] Donec dictum turpis quis pellentesque,[^2] et iaculis tortor condimentum.

[^1]: first footnote
[^2]: second footnote
Re-indexing footnotes after inserting a footnote between Before: 
Lorem ipsum dolor sit amet, consectetur adipiscing elit.[^1] Aenean at aliquet felis. Donec dictum turpis quis ipsum pellentesque, et iaculis tortor condimentum.[^1a] Vestibulum nec blandit felis, vulputate finibus purus.[^2] Praesent quis iaculis diam.

[^1]: first footnote
[^1a]: third footnote, inserted later
[^2]: second footnotes
After: 
Lorem ipsum dolor sit amet, consectetur adipiscing elit.[^1] Aenean at aliquet felis. Donec dictum turpis quis ipsum pellentesque, et iaculis tortor condimentum.[^2] Vestibulum nec blandit felis, vulputate finibus purus.[^3] Praesent quis iaculis diam.

[^1]: first footnote
[^2]: third footnote, inserted later
[^3]: second footnotes
Re-indexing footnotes preserves multiple references to the same footnote index Before: 
Lorem ipsum dolor sit amet, consectetur adipiscing elit.[^1] Aenean at aliquet felis. Donec dictum turpis quis ipsum pellentesque, et iaculis tortor condimentum.[^1a] Vestibulum nec blandit felis, vulputate finibus purus.[^2] Praesent quis iaculis diam.[^1]

[^1]: first footnote
[^1a]: third footnote, inserted later
[^2]: second footnotes
After: 
Lorem ipsum dolor sit amet, consectetur adipiscing elit.[^1] Aenean at aliquet felis. Donec dictum turpis quis ipsum pellentesque, et iaculis tortor condimentum.[^2] Vestibulum nec blandit felis, vulputate finibus purus.[^3] Praesent quis iaculis diam.[^1]

[^1]: first footnote
[^2]: third footnote, inserted later
[^3]: second footnotes
Re-indexing footnotes condense duplicate footnotes into 1 when key and footnote are the same Before: 
bla[^1], bla[^1], bla[^2]
[^1]: bla
[^1]: bla
[^2]: bla
After: 
bla[^1], bla[^1], bla[^2]
[^1]: bla
[^2]: bla