mirror of
https://github.com/primer/css.git
synced 2024-11-11 04:00:54 +03:00
The CSS design system that powers GitHub
cssdesign-systemdesign-systemsframeworkmetaprimerprimer-csssassstarred-primer-repostarred-repostyleguideui-components
| .github | ||
| .storybook | ||
| docs | ||
| docs-test | ||
| fonts | ||
| lib | ||
| pages | ||
| script | ||
| src | ||
| static | ||
| tests | ||
| .eslintrc.json | ||
| .gitignore | ||
| .npmignore | ||
| .npmrc | ||
| .stylelintrc.json | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| DEVELOP.md | ||
| LICENSE | ||
| MIGRATION.md | ||
| next.config.js | ||
| now.json | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.js | ||
| README.md | ||
| RELEASING.md | ||
Primer
Primer CSS is the Sass implementation of Primer, the design system that powers GitHub.
Install
This repository is distributed with npm. After installing npm, you can install @primer/css with this command:
$ npm install --save @primer/css
Usage
The included source files are written in Sass using SCSS syntax. After installing with npm, you can add your project's node_modules directory to your Sass include paths (AKA load paths in Ruby), then import it like this:
@import "@primer/css/index.scss";
You can import individual Primer modules directly from the @primer/css package:
@import "@primer/css/core/index.scss";
@import "@primer/css/product/index.scss";
@import "@primer/css/marketing/index.scss";
Development
See DEVELOP.md for development docs.
Releasing (for GitHub staff)
You can find docs about our release process in RELEASING.md.
Documentation
The Primer CSS docs site in this repo is created with Primer Components, Next, and hosted on Now.