The CSS implementation of GitHub's Primer Design System
npm package build status contributors graph last commit license
⚠️ This project is in KTLO mode! Use existing utility classes from this project where needed. For more complete patterns that include styling and markup, please use primer/react or, if necessary, primer/view_components.
Our documentation site lives at primer.style/css. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.
This repository is distributed with npm. After installing npm, you can install @primer/css with this command:
npm install --save @primer/css
The included source files are written in Sass using SCSS syntax. Once installed, you can add your project's node_modules directory to your Sass include paths (AKA load paths in Ruby), then import it like this:
@import "@primer/css/index.scss";
You can import individual Primer modules directly from the @primer/css package:
@import "@primer/css/core/index.scss"; @import "@primer/css/product/index.scss"; @import "@primer/css/marketing/index.scss";
See DEVELOP.md for development docs.
You can find docs about our release process in RELEASING.md.