1
1
mirror of https://github.com/primer/css.git synced 2024-12-15 23:43:51 +03:00
css/modules/generator-primer-module/app/templates
2017-09-06 16:53:29 -07:00
..
lib stub out yeoman generator 2017-08-31 22:23:17 -07:00
.npmignore add .npmignore for new modules 2017-09-06 12:54:30 -07:00
index.scss expose "lib" (module w/o "primer-" prefix) 2017-09-06 16:53:29 -07:00
LICENSE stub out yeoman generator 2017-08-31 22:23:17 -07:00
package.json clean up, add more tests 2017-09-06 15:33:36 -07:00
README.md clean up, add more tests 2017-09-06 15:33:36 -07:00

Primer CSS / <%= title %>

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

<%= description %>

This repository is a module of the full primer-css 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." %>

License

MIT © GitHub