1
1
mirror of https://github.com/primer/css.git synced 2024-12-25 23:23:47 +03:00
css/packages/primer-product/README.md
2017-06-12 11:53:57 -04:00

1.7 KiB

Primer product

NPM version Build Status

Primer product is one of 3 meta-packages that belong to the Primer CSS framework. Primer product contains packages that are used on GitHub product 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, 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