diff options
Diffstat (limited to 'assets/sass/@primer/css/README.md')
-rw-r--r-- | assets/sass/@primer/css/README.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/assets/sass/@primer/css/README.md b/assets/sass/@primer/css/README.md new file mode 100644 index 0000000..826a7bb --- /dev/null +++ b/assets/sass/@primer/css/README.md @@ -0,0 +1,69 @@ +<p align="center"> + <img width="300px" src="./static/readme.png"> +</p> + +<h1 align="center">Primer CSS</h1> + +<p align="center">The CSS implementation of GitHub's Primer Design System</p> + +<p align="center"> + <a aria-label="npm package" href="https://www.npmjs.com/package/@primer/css"> + <img alt="" src="https://img.shields.io/npm/v/@primer/css.svg"> + </a> + <a aria-label="contributors graph" href="https://github.com/primer/css/graphs/contributors"> + <img src="https://img.shields.io/github/contributors/primer/css.svg"> + </a> + <a aria-label="last commit" href="https://github.com/primer/css/commits/master"> + <img alt="" src="https://img.shields.io/github/last-commit/primer/css.svg"> + </a> + <a aria-label="join us in spectrum" href="https://spectrum.chat/primer"> + <img alt="" src="https://withspectrum.github.io/badge/badge.svg"> + </a> + <a aria-label="license" href="https://github.com/primer/css/blob/master/LICENSE"> + <img src="https://img.shields.io/github/license/primer/css.svg" alt=""> + </a> +</p> + +## Migrating +:rotating_light: **If you currently use the `primer` or `primer-`-prefixed npm packages, please read [the migration guide](MIGRATING.md)!** + +## Install +This repository is distributed with [npm]. After [installing npm][install-npm], you can install `@primer/css` with this command: + +```sh +$ npm install --save @primer/css +``` + +## Usage +The included source files are written in [Sass] using SCSS syntax. After [installing](#install) with npm, you can add your project's `node_modules` directory to your Sass [include paths](https://github.com/sass/node-sass#includepaths) (AKA [load paths](http://technology.customink.com/blog/2014/10/09/understanding-and-using-sass-load-paths/) in Ruby), then import it like this: + +```scss +@import "@primer/css/index.scss"; +``` + +You can import individual Primer modules directly from the `@primer/css` package: + +```scss +@import "@primer/css/core/index.scss"; +@import "@primer/css/product/index.scss"; +@import "@primer/css/marketing/index.scss"; +``` + +## Development +See [DEVELOP.md](./DEVELOP.md) for development docs. + +## Releasing (for GitHub staff) +You can find docs about our release process in [RELEASING.md](./RELEASING.md). + +## Documentation +The [Primer CSS docs site](https://primer.style/css) is deployed from this repo with [primer/deploy](https://github.com/primer/deploy). See [the development docs](DEVELOP.md#docs-site) for more info. + +## License + +[MIT](./LICENSE) © [GitHub](https://github.com/) + + +[install-npm]: https://docs.npmjs.com/getting-started/installing-node +[npm]: https://www.npmjs.com/ +[primer]: https://primer.style +[sass]: http://sass-lang.com/ |