Skip to content
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.

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

Footnotes are not supported in Markdown #323

Open
shenxianpeng opened this issue Jan 16, 2025 · 2 comments · May be fixed by #324
Open

Footnotes are not supported in Markdown #323

shenxianpeng opened this issue Jan 16, 2025 · 2 comments · May be fixed by #324

Comments

@shenxianpeng
Copy link
Contributor

I used footnotes in the project README, which looks like the following.

Image

click [1] to jump to the footnotes

Image


Hower on https://pypi.org/project/gitstats, it will display like this which does not support footnotes

Image

@miketheman
Copy link
Member

This is a CommonMark extension, not enabled by default, and would need to have CMARK_OPT_FOOTNOTES enabled to work.

The way to solve is to add a test fixture test_GFM_footnotes.md and corresponding test_GFM_footnotes.html with the correct rendered output, and then update markdown.py to pass the option.

@shenxianpeng shenxianpeng linked a pull request Jan 17, 2025 that will close this issue
@shenxianpeng
Copy link
Contributor Author

I have opened a pull request #324 to address this issue. Appreciate your review and feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants