Document npmjs.com markdown rendering specifics (#1735)
Edit [the "About package README files" page](https://docs.npmjs.com/about-package-readme-files) to mention that [GitHub Flavored Markdown](https://github.github.com/gfm/) is rendered on npmjs.com. Here's what the page looks like after these changes: <img width="823" height="867" alt="Screenshot 2025-10-06 at 6 55 27 AM" src="https://github.com/user-attachments/assets/5f8843fd-a699-4619-895c-814a262c6424" /> ## References Closes #1734
Matt Kantor committed
Nov 4, 2025 at 12:17 UTC
fa936bddcf3c413ab19785af3bb07e553c229f92
1 file changed
+1
-1
content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx
+1
-1
@@ -2,7 +2,7 @@
2
title: About package README files
3
---
4
5
-We highly recommend including a `README.md` file in your package directory as it helps developers find your package on npm and have a good experience using your code in their projects. In most cases `README.md` files include directions for _installing_, _configuring_, and _using_ the code in your package; as well as any other information a user may find helpful. Just like in any GitHub repository, the `README.md` file will be rendered on the package's page.
5
+We highly recommend including a `README.md` file in your package directory as it helps developers find your package on npm and have a good experience using your code in their projects. In most cases `README.md` files include directions for _installing_, _configuring_, and _using_ the code in your package; as well as any other information a user may find helpful. Just like in any GitHub repository, the `README.md` file will be rendered on the package's page. On [npmjs.com](https://www.npmjs.com/), the `README.md` is rendered as [GitHub Flavored Markdown](https://github.github.com/gfm/) via [GitHub's API](https://docs.github.com/en/rest/markdown/markdown).
6
7
An npm package `README.md` file **must** be in the root-level directory of the package.
8