Primer CSS

Primer is the CSS toolkit that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely GitHubby. It's built with SCSS and available via NPM, so it's easy to include all or part of it within your own project.

This repository is a compilation of several CSS modules.

Documentation

You can read more about support in the docs.

Install

This repository is distributed with npm. After installing npm, you can install primer-css with this command.

$ npm install --save primer-css

Usage

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

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

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled css version of this module, a npm script is included that will output a css version to build/build.css

$ npm run build

Primer stats

When compiling the Sass files, we will automatically generate a .primer-stats.md file. This is tracked in the Git repository to provide us historical and contextual information on the changes we introduce. For example, we'll know when the number of selectors or declarations rises sharply within a single change.

Related

• Primer Documentation
• primer

License

MIT © GitHub