mirror of
https://github.com/primer/css.git
synced 2025-01-05 21:22:57 +03:00
Generating README from script
This commit is contained in:
parent
5f4a6e49de
commit
ca5624fdae
@ -1,38 +1,25 @@
|
||||
# Primer Header
|
||||
---
|
||||
bundle: "header"
|
||||
generated: true
|
||||
---
|
||||
|
||||
> Header that is used on GitHub.com
|
||||
|
||||
This repository is a module of the full [primer][primer] repository.
|
||||
# Primer CSS: `header` bundle
|
||||
|
||||
## 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
|
||||
@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
|
||||
|
||||
A CSS bundle of this module is distributed with the npm package in `dist/header.css`.
|
||||
|
||||
```
|
||||
$ npm run build
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Find further documentation at [primer.style/css/components/header](https://primer.style/css/components/header).
|
||||
|
||||
The `@primer/css` npm package includes a standalone CSS build of this module in `dist/header.css`.
|
||||
|
||||
## 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
|
||||
[npm]: https://www.npmjs.com/
|
||||
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
|
||||
[sass]: http://sass-lang.com/
|
||||
|
||||
[scss]: https://sass-lang.com/documentation/syntax#scss
|
||||
|
Loading…
Reference in New Issue
Block a user