mirror of https://github.com/thangisme/notes.git synced 2024-12-22 19:26:34 -05:00

History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
build	Initial commit	2017-03-09 13:16:08 -05:00
lib	Initial commit	2017-03-09 13:16:08 -05:00
CHANGELOG.md	Initial commit	2017-03-09 13:16:08 -05:00
index.scss	Initial commit	2017-03-09 13:16:08 -05:00
LICENSE	Initial commit	2017-03-09 13:16:08 -05:00
package.json	Initial commit	2017-03-09 13:16:08 -05:00
README.md	Initial commit	2017-03-09 13:16:08 -05: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.