Why are READMEs rendered differently in NPM registry vs. Crates registry for packages? #831
Unanswered
BA-CalderonMorales
asked this question in
Question
Replies: 1 comment 7 replies
-
A likely factor is that annotations were a late addition to GFM so when GFM was implemented on npm, they didn't exist yet. Why they haven't been added since is likely because not much is being done overall on the npm website since the gh acquisition. |
Beta Was this translation helpful? Give feedback.
7 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Genuinely curious here. Specifically the annotations below. Figured this could be something easy to fix.
Thought it was odd that we can't see the following properly formatted in NPM Registry (maybe it's just my laptop?).
Note
Highlights information that users should take into account, even when skimming.
Important
Crucial information necessary for users to succeed.
Warning
Critical content demanding immediate user attention due to potential risks.
Tip
Helpful advice for doing things better or more easily.
Tip
Examples taken from this helpful gist
GitHub and Crates both handle this rendering. Would like to know why NPM Registry doesn't handle this.
Hoping for clarity here. Was going to try to put up a PR myself, however, I'm not even sure where to start looking for this small change to be applied. Hoping to get some help from maintainers.
See differences below (expand/collapse dropdowns for ease of reference):
NPM Registry (README.md)
Crates Registry (README.md)
GitHub (README.md)
Hoping to have a genuine discussion about this. If it's intentional, then maybe a reference to a specific piece of docs would be nice to add to this question and left up in case others run into this.
Beta Was this translation helpful? Give feedback.
All reactions