A simple CSS styleguide generator, from docblocks
$ npm i docss
Return an new Docss
instance for the given string of css.
Use the given plugin fn
. A docss "plugin" is simply a function accepting
the docblocks array and Docss
instance to apply transformation on it.
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>",
]
}]
Return the string representation of the docblocks. //@todo
This library can parse those kind of comment blocks
/**
* Name
*
* Description
* Still description
*
* .state: This is a state
* .state - This is a another
*
* <markup>
*/
/**
* @name Name
*
* @description Description
* Still description
*
* @state .state: This is a state
* @state .state - This is a another
*
* @markup <markup>
*/
/**
Name
Description
Still description
:hover .state: State
*/
/**
* Name
*
* Description
* Still description
*
* @state .state: This is a state
* @state .state - This is a another
*
* @markup <markup>
*/
/**
* @description Description
* Name
*
Still description
*
* @state .state: This is a state
@markup <markup>
* <markup>
*
.another-state - This is a another
*/