Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
docs
lib
stories
.npmignore
LICENSE
README.md
index.scss
package-lock.json
package.json

README.md

Primer Utilities

npm version Build Status

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 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.

License

MIT © GitHub