search

npm / documentation

Documentation for the npm registry, website, and command-line interface.
https://docs.npmjs.com/
Creative Commons Attribution 4.0 International
396 stars 2.81k forks source link

GitHub-Flavored Markdown isn't supported #1240

Open jcayzac opened 2 months ago

jcayzac commented 2 months ago

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

ljharb commented 2 months ago

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

Kenneth-Sills commented 2 months ago

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!

ljharb commented 2 months ago

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