primer/css

mirror of https://github.com/primer/css.git synced 2024-09-21 05:39:15 +03:00

History

broccolini 22a23c2b4c add docs to files key in package.json		2017-08-09 16:41:18 -04:00
..
docs	add primer-utilities docs folder back	2017-08-04 17:37:51 -04:00
lib	fix stray font-weight:normal	2017-07-17 16:57:19 -07:00
.npmignore	rename packages directory to modules	2017-06-29 12:49:16 -07:00
index.scss	rename packages directory to modules	2017-06-29 12:49:16 -07:00
LICENSE	rename packages directory to modules	2017-06-29 12:49:16 -07:00
package.json	add docs to files key in package.json	2017-08-09 16:41:18 -04:00
README.md	rename packages directory to modules	2017-06-29 12:49:16 -07:00

README.md

Primer CSS Utilities

There are a handful of utilities in Primer for quick behaviors, floats, colors, alignment, and more.

This repository is a module of the full primer-css repository.

Install

This repository is distributed with npm. After installing npm, you can install primer-utilities with this command.

$ npm install --save primer-utilities

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-utilities/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 utilities in the docs folder.