npm / doctornpm

A Gatsby theme for npm's documentation (a fork of doctocat)

doctornpm

Warning: The source for this has been moved to the npm/documentation repo.

Did somebody call a doctor? doctornpm is a friendly fork of the doctocat Gatsby theme from GitHub's design systems team for the npm documentation.

Development

If you need to work on the theme for the npm documentation, this is the place to start. This repository includes both the Gatsby theme itself and the documentation for the theme.

(The latter also serves as a great example site to act as a test site for the theme, so that you can view and validate the changes that you're making.)

Prerequisites

Prerequisites: Node.js (LTS) and npm 8.

npm 8 is a requirement since this repository uses workspaces. If you don't have npm 8 yet, you can npm install -g npm@latest.

Getting Started

1. Clone this repository: git clone https://github.com/npm/doctornpm.
2. npm install in the doctornpm directory.
3. npm run develop to build the site and start a local webserver.
4. Visit the documentation site in your local instance, http://localhost:8000/

Publishing

The documentation for the theme is published to the gh-pages branch via a GitHub action. It lives at npm.github.io/doctornpm.