primer/css

mirror of https://github.com/primer/css.git synced 2024-11-11 15:16:03 +03:00

History

Shawn Allen feb07fae52 fix a ton of links		2019-01-11 14:29:22 -08:00
..
docs	fix a ton of links	2019-01-11 14:29:22 -08:00
lib	add missing semicolon	2018-10-22 14:57:56 -07:00
.npmignore	rename packages directory to modules	2017-06-29 12:49:16 -07:00
index.scss	add primer marketing support dependency	2017-11-17 12:06:01 -08:00
LICENSE	update year in licenses and source headers to 2019	2019-01-04 10:38:46 -08:00
package.json	Publish	2019-01-07 15:03:45 -08:00
README.md	add docs, and mention extended scale in primer-support docs too	2017-11-17 12:06:43 -08:00
stories.js	add stories.js for storybook	2017-11-17 12:08:28 -08:00

README.md

Primer Marketing CSS Utilities

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

Install

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

$ npm install --save primer-marketing-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-marketing-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.