.. | ||
.gitignore | ||
.npmignore | ||
CHANGELOG.md | ||
index.scss | ||
LICENSE | ||
package.json | ||
README.md |
Primer Core
Primer core is one of 3 meta-packages that belong to the Primer CSS framework. Primer core contains packages that are shared between GitHub product and marketing websites.
This repository is a compilation of several CSS packages. You can break it down into smaller sections using npm.
Install
This repository is distributed with npm. After installing npm, you can install primer-css
with this command. You must have npm >=3.0 installed to be able to satisfy the dependency paths
$ npm install --save primer-core
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-core/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, an 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.