1
1
mirror of https://github.com/primer/css.git synced 2024-12-28 08:31:58 +03:00
css/packages/primer-product/README.md
2017-05-11 16:12:29 -04:00

1.7 KiB

Primer product

NPM version Build Status

Primer product is the product based 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