gulp-styleguidejs
Generate a styleguide from your CSS, by adding YAML data in the comments. It generates a self-contained html file. Works great for component based CSS.
Issues with output should be reported on the styleguide.js issue tracker
A gulp wrapper for styleguide.js by EightMedia
Install
$ npm install gulp-styleguidejs --save-dev
How to use
var gulp = styleguidejs = ; gulp;
API
styleguidejs([, options])
options
Type: object
Default: none
gulp-styleguidejs takes all styleguide.js options. If no options object is provided, gulp-styleguidejs will automatically output to index.html
. If an options object is given it must contain a value for outputFile
.
Markup
Styleguide.js uses YAML to markup CSS files and generate styleguides.
From the styleguide.js documentation:
/*** title: Square buttons section: Buttons description: Very pretty square buttons example: | <a href="" class="btn btn-small">button</a> <a href="" class="btn btn-medium">button</a> <a href="" class="btn btn-large">button</a>***/
Find out more about using styleguide.js by reading its documentation.