primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2025-01-07 14:58:54 +03:00
Code Issues Projects Releases Wiki Activity

Generating README from script

Browse Source
This commit is contained in:
Jon Rohan 2019-08-08 11:47:11 -07:00
parent 5f4a6e49de
commit ca5624fdae
No known key found for this signature in database
GPG Key ID: B0BBE304A9A0AECB
1 changed files with 10 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/header/README.md
View File

@ -1,38 +1,25 @@
# Primer Header ---
bundle: "header"
generated: true
---
> Header that is used on GitHub.com # Primer CSS: `header` bundle
This repository is a module of the full [primer][primer] repository.
## Usage ## Usage
The source files included are written in [SCSS]. Add the `node_modules` directory to your Sass include paths and import it with: Primer CSS source files are written in [SCSS]. To include this Primer CSS module in your own build, ensure that your `node_modules` directory is listed in your Sass include paths, then import it with:
```scss ```scss
@import "@primer/css/header/index.scss"; @import "@primer/css/header/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 ## Build
A CSS bundle of this module is distributed with the npm package in `dist/header.css`. The `@primer/css` npm package includes a standalone CSS build of this module in `dist/header.css`.
```
$ npm run build
```
## Documentation
Find further documentation at [primer.style/css/components/header](https://primer.style/css/components/header).
## License ## License
[MIT](./LICENSE) © [GitHub](https://github.com/) [MIT](https://github.com/primer/css/blob/master/LICENSE) © [GitHub](https://github.com/)
[primer]: https://github.com/primer/css
[docs]: https://primer.style/css [scss]: https://sass-lang.com/documentation/syntax#scss
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/