styleguide-lite

Simple Styleguide Generator.

Installation

NPM

$ npm install styleguide-lite --save

Usage

CLI

Options:
  --src           src files path pattern. [string] [default: './src/scss/**/*.scss']
  --dest          dest directory path. [string] [default: './dest/assets/styleguide/']
  --template      template file path. [string] [default: __dirname + '/template/index.ejs']
  --version, -v   show this version. [boolean]
  --help, -h      show this help. [boolean]

$ styleguide-lite --src ./src/css/**/*.css --dest ./dest/assets/styleguide/ --template ./template/index.ejs

JavaScript

styleguideLite({
  src: ['./src/scss/**/*.scss'],
  dest: './dest/assets/styleguide/',
  templete: './template/index.ejs'
}).then(() => {
  console.log('complete!!');
});

CSS or SCSS

/*
===
<Section Number>.<Sub Section Number> <Title>
===
<Markdown>
*/
 
/*
===
0.0 Overview
===
Here markup text.
*/
 
/*
===
0.1 Detail
===
Here markup text.
*/
 
/*
===
1.0 Sample
===
Here markup text.
*/

Changelog

License