https://github.com/npm/documentation

Documentation for the npm registry, website, and command-line interface.
https://github.com/npm/documentation

npm-cli

Last synced: about 1 year ago
JSON representation

Documentation for the npm registry, website, and command-line interface.

• Host: GitHub
• URL: https://github.com/npm/documentation
• Owner: npm
• License: cc-by-4.0
• Created: 2020-09-22T21:51:41.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-05-13T02:49:14.000Z (about 1 year ago)
• Last Synced: 2025-05-13T03:32:25.133Z (about 1 year ago)
• Topics: npm-cli
• Language: MDX
• Homepage: https://docs.npmjs.com/
• Size: 71.3 MB
• Stars: 470
• Watchers: 68
• Forks: 3,116
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# npm Documentation

[![Publish](https://github.com/npm/documentation/actions/workflows/publish.yml/badge.svg)](https://github.com/npm/documentation/actions/workflows/publish.yml)

This is the documentation for [https://docs.npmjs.com/](https://docs.npmjs.com/).

[This repository](https://github.com/npm/documentation) contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself.

## Quick start

1. `npm install` to download gatsby, our theme, and the dependencies

2. `npm run develop`: starts the test server at `http://localhost:8000`.

3. Update the content - it's Mdx, which is like markdown - in the `content` directory.

4. Review your content at `http://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 at https://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 will [deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml).

Do you want to know more? Check out our [contributing guide](CONTRIBUTING.md).

## License

The npm product documentation in the content, and static folders are licensed under a [CC-BY 4.0 license](LICENSE).

All other code in this repository is licensed under a [MIT license](LICENSE-CODE).

When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).