Skip to content

Update footnote alternatives with code callouts, and add links #2283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leemthompo merged 3 commits into from
Nov 28, 2025
Merged

Update footnote alternatives with code callouts, and add links #2283

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7ff474
Update footnote alternatives with code callouts, and add links
leemthompo Nov 28, 2025
061291a
Update footnote alternatives with code callouts, and add links (#2284)
Copilot Nov 28, 2025
e1a1b2a
Fix typo
leemthompo Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/syntax/footnotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,10 @@ Each footnote should contain a single, focused piece of information. If you find

Before adding footnotes, consider whether:
- The information is important enough to be in the main text.
- A link to external documentation would be more appropriate.
- An admonition (note, warning, etc.) would be clearer.
- A [link](links.md) to external documentation would be more appropriate.
- An [admonition](admonitions.md) (note, warning, etc.) would be clearer.
- A [code callout](code.md#code-callouts) would work better for code blocks.

### Numbering

Footnotes are automatically numbered in order of first reference, regardless of the identifier you use in your source. This means `[^zebra]` appearing before `[^apple]` will be numbered as footnote 1.
Footnotes are automatically numbered in order of first reference, regardless of the identifier you use in your source. This means `[^zebra]` appearing before `[^apple]` will be numbered as footnote 1.
Loading