1
1
mirror of https://github.com/primer/css.git synced 2024-12-28 08:31:58 +03:00
css/packages/primer-page-sections/README.md
2017-05-11 16:12:29 -04:00

1.7 KiB
Raw Blame History

Primer CSS Page Sections

NPM version Build Status

Flash messages, or alerts, inform users of successful or pending actions. Use them sparingly. Dont show more than one at a time.

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

Documentation

Documentation & refactor coming very soon

Install

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

$ npm install --save primer-page-sections

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-page-sections/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

$ npm run build

License

MIT © GitHub