Repository files navigation

This is the documentation forhttps://docs.npmjs.com/.

This repository contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself.

1. npm install to download gatsby, our theme, and the dependencies
2. npm run develop: starts the test server athttp://localhost:8000.
3. Update the content - it's Mdx, which is like markdown - in thecontent directory.
4. Review your content athttp://localhost:8000. (Gatsby watches the filesystem and will reload your content changes immediately.)
5. Once you're happy, commit it and open a pull request athttps://github.com/npm/documentation.
6. A CI workflow run will publish your PR to a GitHub Preview Page.
7. Once the content is reviewed, merge the pull request. That willdeploy the site.

Do you want to know more? Check out ourcontributing guide.

The npm product documentation in the content, and static folders are licensed under aCC-BY 4.0 license.

All other code in this repository is licensed under aMIT license.

When using the GitHub logos, be sure to follow theGitHub logo guidelines.