What markdown renderer is used on npmjs.com for READMEs?

[mkantor]

It would be great if https://docs.npmjs.com/about-package-readme-files mentioned what markdown renderer is used. At some point in the past it was marky-markdown, but that repository has been archived and the package hasn't seen an update in years, so I doubt it's still the one.

I was specifically wondering what syntax extensions are available, but had to resort to publishing a dummy package to figure that out via trial and error.

[wraithgar]

It's the GitHub flavored markdown renderer. https://docs.github.com/en/rest/markdown/markdown?apiVersion=2022-11-28

Extensions are included in the docs https://github.github.com/gfm/

[mkantor]

@wraithgar thanks, that makes sense. Would you be open to a pull request which explicitly mentions this on https://docs.npmjs.com/about-package-readme-files?

[mkantor]

Also, do you know if there's an up-to-date GFM spec anywhere? The one you linked to was last updated in 2019 and doesn't include newer stuff like footnote syntax (which I confirmed does work on npmjs.com).

[wraithgar]

Would you be open to a pull request which explicitly mentions this on https://docs.npmjs.com/about-package-readme-files?

Yes that would make sense. Make sure that it clarifies that it is npmjs.com that does this. Other registry websites may use other renderers.

I don't know about any other GFM spec out there. You may need to go through GitHub support to find that out.

[mkantor]

I don't know about any other GFM spec out there. You may need to go through GitHub support to find that out.

Looks like there are already a bunch of open issues about it: github/cmark-gfm#220, github/cmark-gfm#270, github/cmark-gfm#283, github/cmark-gfm#288, etc.