Skip to content

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

License

CC-BY-4.0, MIT licenses found

Licenses found

CC-BY-4.0
LICENSE
MIT
LICENSE-CODE
Notifications You must be signed in to change notification settings

npm/documentation

Folders and files

NameName
Last commit message
Last commit date
Aug 27, 2024
Oct 23, 2023
May 20, 2021
Feb 5, 2025
Jan 29, 2025
Aug 27, 2024
Dec 2, 2024
Dec 3, 2024
Oct 9, 2024
Dec 17, 2024
Oct 23, 2023
Jul 16, 2024
Dec 17, 2024
Oct 23, 2023
Oct 23, 2023
Oct 23, 2023
Jul 16, 2024
Apr 5, 2021
Apr 5, 2021
Oct 23, 2023
Jul 18, 2024
Feb 5, 2025
Dec 4, 2023
Nov 22, 2024
Oct 23, 2023
Oct 23, 2023
Oct 23, 2023
Oct 23, 2023
Nov 22, 2024
Feb 11, 2025
Feb 5, 2025
Jun 12, 2024

npm Documentation

Publish

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.

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.

Do you want to know more? Check out our contributing guide.

License

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.

About

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

Topics

Resources

License

CC-BY-4.0, MIT licenses found

Licenses found

CC-BY-4.0
LICENSE
MIT
LICENSE-CODE

Code of conduct

Security policy

Stars

Watchers

Forks