.. | ||
lib | ||
.npmignore | ||
index.scss | ||
LICENSE | ||
package.json | ||
README.md |
Primer CSS / <%= title %>
[![npm version](http://img.shields.io/npm/v/<%= module %>.svg)](https://www.npmjs.org/package/<%= module %>)
<%= 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." %>