The place where all things npm are documented.
All the markdown files can be found in the content directory. Some of these files live here in this repository, others live in other repositories and are imported during the build process. These imported files are ignored by git to prevent people from accidentally editing the wrong files.
This site uses html-frontmatter to add metadata to pages.
If a file has a
title property in its frontmatter, it will be used for
<title> of the rendered HTML page. If
title is absent from the
frontmatter, the filename (without the .md extension) is used.
Pages are sorted alphabetically by default, but the page order per section
can be overridden by using a numerical
order frontmatter property. It is
not necessary to order all pages in a section: Any pages in a section that
don't have an
order property will be relegated to the end of that section.
If you rename or remove a file, add it to lib/redirects.js to keep things from breaking.
Download node at nodejs.org and install it, if you haven't already.
To run the app locally:
npm installnpm run dev
The build is run automatically after every
npm install and before
npm start. Here's an overview of what it does.
The copied and generated files are ignored for two reasons:
The content.json file is served publicly at
with CORS support, allowing browsers on other domains to fetch all the npm
documentation and accompanying metadata with a single HTTP call.
npm installnpm test
git push origin +master:deploy-staginggit push origin +master:deploy-production
If you get dissed with an "Everything up-to-date" message, make an empty commit and push again:
git commit -avm "emptiness" --allow-empty