primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-23 14:13:14 +03:00
Code Issues Projects Releases Wiki Activity

update submodule usage guidance

Browse Source
This commit is contained in:
Shawn Allen 2017-06-22 12:32:28 -07:00
parent 3457e98548
commit fa2fe39270
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -34,6 +34,25 @@ The source files included are written in [Sass][sass] (SCSS). You can point your
@import "primer-css/index.scss"; @import "primer-css/index.scss";
``` ```
You can import individual Primer modules by installing them each with npm, for instance:
```sh
$ npm install --save primer-navigation
```
Then, you would import the module with:
```scss
@import "primer-navigation/index.scss";
```
Or, while you're figuring out which modules you need, you can import them directly from the `primer-css` [`packages` directory](./packages) like so:
```scss
@import "primer-css/packages/primer-navigation/index.css";
```
## Build ## Build
For a compiled **CSS** version of this module, an 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. For a compiled **CSS** version of this module, an 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.