primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-30 09:36:07 +03:00
Code Issues Projects Releases Wiki Activity
2c0e3eb1d9
css/packages/primer-core
History
broccolini 2c0e3eb1d9 update npm to lowercase
2017-06-23 16:57:00 -04:00
..
.gitignore rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
.npmignore rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
CHANGELOG.md rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
index.scss rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
LICENSE rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
package.json Publish 2017-06-19 19:41:06 -04:00
README.md update npm to lowercase 2017-06-23 16:57:00 -04:00

README.md

Primer Core

npm version Build Status

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.

License

MIT © GitHub