README

Primer CSS
The CSS implementation of GitHub's Primer Design System







 :warning: 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.

 Documentation
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.

 Install
This repository is distributed with [npm]. After [installing npm][install-npm], you can install @primer/css with this command:

sh
npm install --save @primer/css


 Usage
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:

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


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

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


 Development
See DEVELOP.md for development docs.

 Releasing (for GitHub staff)
You can find docs about our release process in RELEASING.md.

 License

MIT © GitHub


[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[npm]: https://www.npmjs.com/
[sass]: http://sass-lang.com/