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

49 lines
1.7 KiB
Markdown

# Primer product
[![NPM version](http://img.shields.io/npm/v/primer-product.svg)](https://www.npmjs.org/package/primer-product)
[![Build Status](https://travis-ci.org/primer/primer-product.svg?branch=master)](https://travis-ci.org/primer/primer-product)
> 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](https://github.com/primer). You can break it down into smaller sections using npm.
## Install
This repository is distributed with [npm][npm]. After [installing npm][install-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][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
```scss
@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][docs].
## License
[MIT](./LICENSE) © [GitHub](https://github.com/)
[primer]: https://github.com/primer/primer
[docs]: http://primercss.io/
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/