1
1
mirror of https://github.com/primer/css.git synced 2024-12-20 12:42:07 +03:00
css/modules/primer-core
2017-05-11 15:07:16 -04:00
..
.gitignore move modules into modules folder 2017-05-11 15:07:16 -04:00
.npmignore move modules into modules folder 2017-05-11 15:07:16 -04:00
.travis.yml move modules into modules folder 2017-05-11 15:07:16 -04:00
CHANGELOG.md move modules into modules folder 2017-05-11 15:07:16 -04:00
index.scss move modules into modules folder 2017-05-11 15:07:16 -04:00
LICENSE move modules into modules folder 2017-05-11 15:07:16 -04:00
package.json move modules into modules folder 2017-05-11 15:07:16 -04:00
README.md move modules into modules folder 2017-05-11 15:07:16 -04:00

Primer Core

NPM version Build Status

Primer core is the core modules of the primer framework. Shared between our product and marketing pages.

This repository is a compilation of several CSS modules. You can break it down into smaller sections using npm.

Install

This repository is distributed with npm. After installing npm, you can install primer-css with this command. You must have npm >=3.0 installed to be able to satisfy the dependency paths

$ npm install --save primer-core

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-core/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.

License

MIT © GitHub