Skip to content

feat: add markdown footnotes support#175

Open
thomapapavramidis wants to merge 1 commit intoaccretional:mainfrom
thomapapavramidis:footnotes
Open

feat: add markdown footnotes support#175
thomapapavramidis wants to merge 1 commit intoaccretional:mainfrom
thomapapavramidis:footnotes

Conversation

@thomapapavramidis
Copy link

Purpose of this pull request:
Description
Added MD/MDX footnote support with accessible references, styling, and improved scrolling.

IMPORTANT - UI CHANGE DEMONSTRATION

Screenshots:
Footnote MD file
Footnote Local Site Demo

@ben-fultz
Copy link
Contributor

I looked into it and the remark-gfm plugin we're using can already handle footnotes, do you think we could use that instead of needing to add and maintain a custom remark plugin?

@thomapapavramidis
Copy link
Author

I looked into it and the remark-gfm plugin we're using can already handle footnotes, do you think we could use that instead of needing to add and maintain a custom remark plugin?

Yeah good point. The issue I had observed was incorrect rendering for consecutive footnote definitions (the second definition appeared as literal markdown), and I added a regression test for that. But I agree I should avoid adding maintenance burden if remark-gfm can cover this directly (which it definitely can). If you want I’ll refactor to use remark-gfm and keep only the styling improvements.

@ben-fultz
Copy link
Contributor

Yeah think that would be the best long term, thanks.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants