Skip to content

Support footnotes in Markdown #324

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Support footnotes in Markdown #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6f0023
feat: support footnotes in markdown
shenxianpeng Jan 17, 2025
a3a6093
fix lint error
shenxianpeng Jan 17, 2025
c1940d3
Merge branch 'main' into support-footnotes
miketheman Jan 18, 2025
87cbbdd
update footnotes test output to fix test fail
shenxianpeng Jan 18, 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
6 changes: 4 additions & 2 deletions readme_renderer/markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@
from cmarkgfm.cmark import Options as cmarkgfmOptions
variants: Dict[str, Callable[[str], str]] = {
"GFM": lambda raw: cast(str, cmarkgfm.github_flavored_markdown_to_html(
raw, options=cmarkgfmOptions.CMARK_OPT_UNSAFE
raw, options=(
cmarkgfmOptions.CMARK_OPT_UNSAFE | cmarkgfmOptions.CMARK_OPT_FOOTNOTES)
)),
"CommonMark": lambda raw: cast(str, cmarkgfm.markdown_to_html(
raw, options=cmarkgfmOptions.CMARK_OPT_UNSAFE
raw, options=(
cmarkgfmOptions.CMARK_OPT_UNSAFE | cmarkgfmOptions.CMARK_OPT_FOOTNOTES)
)),
}
except ImportError:
Expand Down
8 changes: 8 additions & 0 deletions tests/fixtures/test_GFM_footnotes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<p>a statement<sup><a href="#fn-1" id="fnref-1" rel="nofollow">1</a></sup></p>
<section>
<ol>
<li id="fn-1">
<p>this is true <a href="#fnref-1" rel="nofollow">↩</a></p>
</li>
</ol>
</section>
3 changes: 3 additions & 0 deletions tests/fixtures/test_GFM_footnotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
a statement[^1]

[^1]: this is true
Loading