A simple CSS styleguide generator, from docblocks
Install
$ npm i docss
API
docss(css)
Return an new Docss
instance for the given string of css.
Docss#use(fn)
Use the given plugin fn
. A docss "plugin" is simply a function accepting
the docblocks array and Docss
instance to apply transformation on it.
Docss#toArray
Return an array containing all docblocks with the structure below
"name": "Name" "description": "lines" "of" "description" "states": ":hover": "state" ".state": "another tate" "markup": "<markup>" "example" "</markup>"
Docss#toString
Return the string representation of the docblocks. //@todo
Possible Comment blocks
This library can parse those kind of comment blocks
Expanded block (recommanded)
/**
* Name
*
* Description
* Still description
*
* .state: This is a state
* .state - This is a another
*
* <markup>
*/
Verbose block (DSS style)
/**
* @name Name
*
* @description Description
* Still description
*
* @state .state: This is a state
* @state .state - This is a another
*
* @markup <markup>
*/
Condensed block (KSS style)
/**
Name
Description
Still description
:hover .state: State
*/
Mixed style
/**
* Name
*
* Description
* Still description
*
* @state .state: This is a state
* @state .state - This is a another
*
* @markup <markup>
*/
Shitty style (seriously not recommanded)
/**
* @description Description
* Name
*
Still description
*
* @state .state: This is a state
@markup <markup>
* <markup>
*
.another-state - This is a another
*/