# styleguide

  Dynamically build [KSS](http://warpspire.com/kss/)-based styleguides

## Installation

  $ npm install styleguide

## Help

  $ ./bin/styleguide --help

## Run

  $ ./bin/styleguide -c [location of CSS files] -h [location of HTML partials] -d [location of data files] -o [output location]

## Use it with Grunt

  [grunt-sg](https://npmjs.org/package/grunt-sg)

## File Name Conventions

  Running the styleguide will look for KSS comments in your SCSS (CSS) partials. It will then look for matching HTML (Handlebars) and data (YML) files.

  For example:
    css/
      _header.scss  (contains KSS style block)

    partials/
      _header.hbs   (contains markup)

    data/
      _header.yml   (contains data for the Handlebars template)

## Legal Stuff
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.