primer/css

mirror of https://github.com/primer/css.git synced 2024-12-21 05:01:45 +03:00

History

broccolini 2c0e3eb1d9 update npm to lowercase		2017-06-23 16:57:00 -04:00
..
CHANGELOG.md	move primer-css module into packages	2017-06-09 17:02:43 -04:00
index.scss	move primer-css module into packages	2017-06-09 17:02:43 -04:00
LICENSE	move primer-css module into packages	2017-06-09 17:02:43 -04:00
package.json	update npm to lowercase	2017-06-23 16:57:00 -04:00
README.md	update npm to lowercase	2017-06-23 16:57:00 -04:00

README.md

Primer CSS

Primer is the CSS framework that powers GitHub's front-end design. Primer CSS includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.

This repository is a compilation of several CSS modules.

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 The built CSS file is also included in the npm package.

$ npm run build

Documentation

You can read more about primer in the docs.