dhei/classic-tokens
@reggi/path-to-regexp
dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
dependabot/npm_and_yarn/main/eslint-10.4.0
dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0
dependabot/npm_and_yarn/main/proc-log-7.0.0
dependabot/npm_and_yarn/npm_and_yarn-826852524d
dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2
deprecate-totp-2fa
dhei/classic-tokens
gat-bypass-2fa-docs
jpg619/fix-accessibility-content-flow
jpg619/version-bump-tar-2
kartykp/gat-bypass-2fa-docs
kartykp/upgrade-path-to-regex
main
maitxn/version-bump-tar
patch-1
reggi/cache-based-on-version
reggi/dev-engines
reggi/fix-transform-prettier
reggi/overrides
update-search-sensitivity
| 1 | # npm Documentation |
| 2 | |
| 3 | [](https://github.com/npm/documentation/actions/workflows/publish.yml) |
| 4 | |
| 5 | This is the documentation for [https://docs.npmjs.com/](https://docs.npmjs.com/). |
| 6 | |
| 7 | [This repository](https://github.com/npm/documentation) contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself. |
| 8 | |
| 9 | ## Quick start |
| 10 | |
| 11 | 1. `npm install` to download gatsby, our theme, and the dependencies |
| 12 | 2. `npm run develop`: starts the test server at `http://localhost:8000`. |
| 13 | 3. Update the content - it's Mdx, which is like markdown - in the `content` directory. |
| 14 | 4. Review your content at `http://localhost:8000`. (Gatsby watches the filesystem and will reload your content changes immediately.) |
| 15 | 5. Once you're happy, commit it and open a pull request at https://github.com/npm/documentation. |
| 16 | 6. A CI workflow run will publish your PR to a GitHub Preview Page. |
| 17 | 7. Once the content is reviewed, merge the pull request. That will [deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml). |
| 18 | |
| 19 | Do you want to know more? Check out our [contributing guide](CONTRIBUTING.md). |
| 20 | |
| 21 | ## License |
| 22 | |
| 23 | The npm product documentation in the content, and static folders are licensed under a [CC-BY 4.0 license](LICENSE). |
| 24 | |
| 25 | All other code in this repository is licensed under a [MIT license](LICENSE-CODE). |
| 26 | |
| 27 | When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). |