primer/css

mirror of https://github.com/primer/css.git synced 2024-12-01 04:21:12 +03:00

History

Shawn Allen 3ef9525d25 add default stories.js to module template		2018-10-18 12:54:07 -07:00
..
lib	move generator-primer-module to /tools/	2017-10-10 11:50:55 -07:00
.npmignore	move generator-primer-module to /tools/	2017-10-10 11:50:55 -07:00
index.scss	move generator-primer-module to /tools/	2017-10-10 11:50:55 -07:00
LICENSE	Happy new year	2018-01-03 15:05:16 -08:00
package.json	Adding notify script to the rest of the modules	2018-06-28 16:20:51 -07:00
README.md	Changing shields.io url to https	2017-11-15 10:08:26 -08:00
stories.js	add default stories.js to module template	2018-10-18 12:54:07 -07:00

README.md

Primer / <%= title %>

[![npm version](https://img.shields.io/npm/v/<%= module %>.svg)](https://www.npmjs.org/package/<%= module %>)

<%= description %>

This repository is a module of the full primer repository.

Install

This repository is distributed with npm. After installing npm, you can install <%= module %> with this command.

$ npm install --save <%= module %>

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 "<%= module %>/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, an 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

<%= docs || "TODO: Write some documentation here." %>