Skip to content

lindenthal/design

This branch is 150 commits behind primer/design:main.

Folders and files

NameName
Last commit message
Last commit date
Dec 19, 2023
Dec 20, 2023
Dec 22, 2022
Dec 12, 2023
Apr 14, 2022
Aug 16, 2022
Feb 8, 2023
Jan 30, 2023
Nov 29, 2023
May 29, 2019
Oct 23, 2023
Apr 17, 2020
Oct 23, 2023
Aug 16, 2022
Oct 23, 2023
Oct 20, 2023
Aug 15, 2023
Oct 23, 2023
Aug 16, 2022
Sep 1, 2023
Dec 5, 2023

Repository files navigation

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?

I need help getting started.

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)

About

Primer Design Guidelines

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 83.0%
  • JavaScript 10.9%
  • TypeScript 6.1%