documentation icon indicating copy to clipboard operation
documentation copied to clipboard

GitHub-Flavored Markdown isn't supported

Open jcayzac opened this issue 1 year ago • 3 comments

See e.g. this package documentation rendered on npmjs.com versus the same thing rendered on GitHub. Admonitions aren't rendered on npmjs.com.

jcayzac avatar Aug 21 '24 23:08 jcayzac

To be fair, it's a brand new GFM feature.

ljharb avatar Aug 22 '24 00:08 ljharb

I wouldn't call it brand new, it's coming up on 9 months since official release, but it's not technically an official part of the GFM specification and definitely easy to overlook or deprioritize in the scheme of things. 😄

Anywho, I also find the raw syntax a bit jarring, so I just threw together a userscript to fix the rendering like:

image

Quickly tested in ViolentMonkey against the package linked above. Does the trick for me!

@ljharb I briefly looked around, but didn't see anywhere in the NPM org where those package pages are rendered. Do you know if that's open source and where I could contribute to a proper fix, or if it's closed and we just need to wait for a staffer to pick it up? Thanks!

Kenneth-Sills avatar Aug 30 '24 04:08 Kenneth-Sills

I believe it's closed and only staff can do something about it.

ljharb avatar Aug 30 '24 04:08 ljharb