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

Add support to the existing marked markdown preset for footnotes #10

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

lschierer
Copy link

it turned out to be trivial to add GFM footnote support with marked-footnote to the existing marked markdown preset. I suppose this could be optional, but I'm not sure how to add in an option to the preset plugin's config, though if such an option existed, it would be easy to change the way marked is called based on that option. As it stands, with this patch, it is on all the time.

@JulianCataldo JulianCataldo changed the base branch from main to next December 17, 2024 16:31
@JulianCataldo
Copy link
Contributor

Hey! Thanks for the idea.

I think it is a reasonable goal for the minimal preset to be able to support GFM entirely.
Tables etc. are already extended syntax / GFM-flavored, supersets of CommonMark.

Footnotes are expected to be supported IMO. They're kind of standard and widespread. I personally don't use them or encounter them very much though.

I've thoroughly checked and the dep's graph is shallow (just one package), so it will not make the preset too fat, which would defeat the purpose.

I'm gonna test it locally and merge it ASAP.

I think GitHub admonitions could be a pretty good addition, to: https://github.com/bent10/marked-extensions/tree/main/packages/alert
Those I use extensively.
I expect READMEs in a GH repo to be displayed with the same features if ingested into a website renderer, no more, no less.

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