README.md

Primer Design System documentation

Documentation for all things Primer, including components, UI patterns, foundations, guides, and more.

Status

This repository is evolving as our documentation needs change. See our contribution guides here.

Project board (GitHub staff only)

Local development

1. Clone this repo, e.g. with:

   git clone https://github.com/primer/design

2. In the terminal, navigate (cd) to the repo directory

3. nvm use --default to use the correct node version.

4. yarn to install dependencies

5. yarn start to start the dev server

Deployment

We deploy this site using GitHub Pages. Every push to a branch other than main will deploy to a URL unique to the preview environment. Merges to main will automatically deploy the site to https://primer.style/.

FAQ

How do I add documentation for a new component or edit existing component documentation?

• Our component documentation files are found here, and guidelines for adding content can be found under the Documenting components section of the Contributing guidelines.
• For a more detailed walk-through, check out this tutorial video.

I need help getting started.

• Check out our getting started guides or ping us in Slack (GitHub staff only)

I noticed a bug in the documentation!

• Feel free to open a pull request or issue directly in this repository, or ping us in Slack (GitHub staff only)