This is the documentation for https://docs.npmjs.com/.
This repository contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself.
npm installto download gatsby, our theme, and the dependenciesnpm run develop: starts the test server athttp://localhost:8000.- Update the content - it's Mdx, which is like markdown - in the
contentdirectory. - Review your content at
http://localhost:8000. (Gatsby watches the filesystem and will reload your content changes immediately.) - Once you're happy, commit it and open a pull request at https://github.com/npm/documentation.
- A CI workflow run will publish your PR to a GitHub Preview Page.
- Once the content is reviewed, merge the pull request. That will deploy the site.
Do you want to know more? Chec 6D23 k out our contributing guide.
The npm product documentation in the content, and static folders are licensed under a CC-BY 4.0 license.
All other code in this repository is licensed under a MIT license.
When using the GitHub logos, be sure to follow the GitHub logo guidelines.