npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

styleguide

0.1.7 • Public • Published

styleguide

Dynamically build 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

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

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Keywords

none

install

npm i styleguide

Downloadsweekly downloads

31

version

0.1.7

license

none

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability