|
|
||
|---|---|---|
| .github | ||
| packages | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| lerna.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
Primer CSS
Primer is the CSS framework that powers GitHub's front-end design. Primer CSS includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via NPM, so it's easy to include all or part of Primer within your own project.
Packages
The Primer CSS repo is managed as a monorepo that is composed of many NPM packages.
Core Packages
| Package | Version |
|---|---|
| primer-css Includes all 23 packages |
|
| primer-core |  |
| primer-product |  |
| primer-marketing |  |
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 source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.
@import "primer-css/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
For a compiled CSS version of this module, a 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.
$ npm run build
Documentation
You can read more about primer in the docs.