Skip to content

Don't add an empty footnotes block when no footnote is referenced #758

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

Open
RavSinghChandan wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Don't add an empty footnotes block when no footnote is referenced #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b7ac10
Don't add an empty footnotes block when no footnote is referenced
RavSinghChandan Oct 30, 2026
89bdd83
Add a changelog entry
RavSinghChandan Oct 31, 2026
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
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## python-markdown2 2.5.6 (not yet released)

- [pull #758] Fix `footnotes` extra adding an empty footnotes block when no footnote is referenced.
- [pull #746] Preserve query strings and fragments in `markdown-file-links` conversions, including reference-link targets.
- [pull #739] Fix `header-ids` extra putting sanitized HTML into header ids in safe mode, which allowed attribute injection (#649)
- [pull #732] Fix excessive CPU use in the inline HTML tokenizer on repeated unclosed tag fragments (#707)
Expand Down
3 changes: 2 additions & 1 deletion lib/markdown2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2280,7 +2280,8 @@ def _form_paragraphs(self, text: str) -> str:
return "\n\n".join(grafs)

def _add_footnotes(self, text: str) -> str:
if self.footnotes:
# Only referenced footnotes are listed, so there is nothing to add without any reference
if self.footnote_ids:
footer = [
'<div class="footnotes">',
'<hr' + self.empty_element_suffix,
Expand Down
1 change: 1 addition & 0 deletions test/tm-cases/footnotes_unreferenced.opts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"extras": ["footnotes"]}
3 changes: 3 additions & 0 deletions test/tm-cases/footnotes_unreferenced.text
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This paragraph has no footnote marker.

[^1]: A footnote that is never referenced.