1
1
mirror of https://github.com/primer/css.git synced 2024-11-10 07:58:36 +03:00
css/modules/primer-core
2017-09-21 13:30:13 -07:00
..
.npmignore rename packages directory to modules 2017-06-29 12:49:16 -07:00
index.scss Moving primer-breadcrumbs to core 2017-09-06 12:13:00 -07:00
LICENSE update copyright year to 2017 2017-08-31 09:52:28 -07:00
package.json Merge branch 'dev' into merge-9.4.0-dev 2017-09-21 13:30:13 -07:00
README.md rename packages directory to modules 2017-06-29 12:49:16 -07:00

Primer Core

npm version Build Status

Primer core is one of 3 meta-packages that belong to the Primer CSS framework. Primer core contains packages that are shared between GitHub product and marketing websites.

This repository is a compilation of several CSS packages. 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, an 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