blob: 826a7bb2602183adbe4413bb7a1229dd7828e2db (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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/
|
