ddonche/sheriff
0.16.0
1
0
tutorial docs
[[footnotes]]

Footnotes & References


Footnotes are built into Sheriff via the Markdown renderer (Comrak). They’re perfect for citations, side commentary, or reference lists that shouldn’t interrupt the main flow.

This page always shows:

  1. The exact Markdown you type
  2. The rendered result

So you never have to guess.


1. The Smallest Possible Footnote

What you write

Here’s a sentence with a footnote.[^one]

[^one]: This is the footnote text.
Here’s a sentence with a footnote.[^one]

[^one]: This is the footnote text.

What it renders

Here’s a sentence with a footnote.1


2. Multiple Footnotes in One Paragraph

What you write

The design prioritizes readability and speed.[^readability][^perf]

[^readability]: Readability wins when docs are used under pressure.
[^perf]: Static builds are fast because they ship HTML, not a server.
The design prioritizes readability and speed.[^readability][^perf]

[^readability]: Readability wins when docs are used under pressure.
[^perf]: Static builds are fast because they ship HTML, not a server.

What it renders

The design prioritizes readability and speed.23


3. Reusing the Same Footnote ID

You can reference the same definition multiple times.

What you write

You can cite the same source twice.[^same]

Later, cite it again.[^same]

[^same]: One footnote definition, reused multiple times.
You can cite the same source twice.[^same]

Later, cite it again.[^same]

[^same]: One footnote definition, reused multiple times.

What it renders

You can cite the same source twice.4

Later, cite it again.4


4. Multi‑Paragraph Footnotes

This is where indentation matters.

If you want multiple paragraphs inside a single footnote, indent continuation lines with 4 spaces.

What you write

This claim needs nuance.[^nuance]

[^nuance]: First paragraph of the footnote.

    Second paragraph of the same footnote.

    Third paragraph, still the same footnote.
This claim needs nuance.[^nuance]

[^nuance]: First paragraph of the footnote.

    Second paragraph of the same footnote.

    Third paragraph, still the same footnote.

What it renders

This claim needs nuance.5


5. Lists Inside a Footnote

Lists must also be indented to stay inside the footnote.

If you do not indent them, Markdown will treat them as normal content below the footnote.

What you write

This pattern has multiple parts.[^list]

[^list]: The system requires:

    - Stable parsing
    - Clean rendering
    - Predictable styling
This pattern has multiple parts.[^list]

[^list]: The system requires:

    - Stable parsing
    - Clean rendering
    - Predictable styling

What it renders

This pattern has multiple parts.6

Notice the indentation in the Markdown. That is what keeps the list inside the footnote.


6. Reference Style Examples

Sheriff does not enforce citation format. You choose the style.

Below are a few common patterns.


A. Note‑Style Commentary

What you write

The new routing model reduces churn.[^note-style]

[^note-style]: Internal note: the win here is fewer edge-case rewrites.
The new routing model reduces churn.[^note-style]

[^note-style]: Internal note: the win here is fewer edge-case rewrites.

What it renders

The new routing model reduces churn.7


B. APA‑Style (Full Format)

What you write

Signal calibration follows a predictable human pattern.[^apa1]

[^apa1]: AuthorLast, A. A. (2020). *Title of the work: Subtitle*. Publisher. https://example.com
Signal calibration follows a predictable human pattern.[^apa1]

[^apa1]: AuthorLast, A. A. (2020). *Title of the work: Subtitle*. Publisher. https://example.com

What it renders

Signal calibration follows a predictable human pattern.8


C. Docs “APA‑Lite” (Recommended for Portals)

Short, readable, credible.

What you write

Comrak supports CommonMark extensions, including footnotes.[^apalite]

[^apalite]: Comrak docs — “Footnotes” extension. (Accessed 2026‑03‑03)
Comrak supports CommonMark extensions, including footnotes.[^apalite]

[^apalite]: Comrak docs — “Footnotes” extension. (Accessed 2026‑03‑03)

What it renders

Comrak supports CommonMark extensions, including footnotes.9


D. Spec / RFC Key Style

What you write

This behavior matches the spec.[^RFC9110]

[^RFC9110]: RFC 9110 — HTTP Semantics.
This behavior matches the spec.[^RFC9110]

[^RFC9110]: RFC 9110 — HTTP Semantics.

What it renders

This behavior matches the spec.10


Common Mistakes

Forgot the definition

This has a footnote.[^oops]
This has a footnote.[^oops]

If you never define [^oops]: ..., nothing will render at the bottom.


Forgot indentation in multi‑paragraph notes

Wrong:

[^bad]: First paragraph.

Second paragraph (this will break out of the footnote).
[^bad]: First paragraph.

Second paragraph (this will break out of the footnote).

Correct:

[^good]: First paragraph.

    Second paragraph (indented 4 spaces).
[^good]: First paragraph.

    Second paragraph (indented 4 spaces).


Quick Copy / Paste

Minimal:

Text here.[^1]

[^1]: Footnote text.
Text here.[^1]

[^1]: Footnote text.

Reusable key:

Spec reference.[^RFC9110]

[^RFC9110]: RFC 9110 — HTTP Semantics.
Spec reference.[^RFC9110]

[^RFC9110]: RFC 9110 — HTTP Semantics.

  1. This is the footnote text.

  2. Readability wins when docs are used under pressure.

  3. Static builds are fast because they ship HTML, not a server.

  4. One footnote definition, reused multiple times. 2

  5. First paragraph of the footnote.

    Second paragraph of the same footnote.

    Third paragraph, still the same footnote.

  6. The system requires:

    • Stable parsing
    • Clean rendering
    • Predictable styling
  7. Internal note: the win here is fewer edge-case rewrites.

  8. AuthorLast, A. A. (2020). Title of the work: Subtitle. Publisher. https://example.com

  9. Comrak docs — “Footnotes” extension. (Accessed 2026‑03‑03)

  10. RFC 9110 — HTTP Semantics.