Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/primer/css

The CSS design system that powers GitHub
https://github.com/primer/css

css design-system design-systems framework meta primer primer-css sass styleguide ui-components

Last synced: about 2 months ago
JSON representation

The CSS design system that powers GitHub

Lists

README 

        


  




Primer CSS



The CSS implementation of GitHub's Primer Design System





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  




## Documentation



> :warning: **The documentation of this repo is not maintained anymore**. Please raise any documentation-specific pull requests in [primer.style/design](https://github.com/primer/design/) 



Our documentation site lives at [primer.style/css](https://primer.style/css). You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.



## 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).



## 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/