Skip to content

primer/css

Repository files navigation

Primer CSS

The CSS implementation of GitHub's Primer Design System

Documentation

⚠️The documentation of this repo is not maintained anymore.Please raise any documentation-specific pull requests inprimer.style/design

Our documentation site lives atprimer.style/css.You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

Install

This repository is distributed withnpm.Afterinstalling npm,you can install@primer/csswith this command:

npm install --save @primer/css

Usage

The included source files are written inSassusing SCSS syntax. Afterinstallingwith npm, you can add your project'snode_modulesdirectory to your Sassinclude paths(AKAload pathsin Ruby), then import it like this:

@import"@primer/css/index.scss";

You can import individual Primer modules directly from the@primer/csspackage:

@import"@primer/css/core/index.scss";
@import"@primer/css/product/index.scss";
@import"@primer/css/marketing/index.scss";

Development

SeeDEVELOP.mdfor development docs.

Releasing (for GitHub staff)

You can find docs about our release process inRELEASING.md.

License

MIT©GitHub