Installation
npm install --save doki
Basic usage
const Doki = ;let doki = 'my-css-files/*.scss';let output = doki;
Your .css
file
/** * @name Button * @description Your standard form button. * * @state :hover - Highlights when hovering. * @state :disabled - Dims the button when disabled. * @state .primary - Indicates button is the primary action. * @state .smaller - A smaller button * * @markup * <button>This is a button</button> */
output
"name": "Button" "description": "Your standard form button." "state": "name": ":hover" "escaped": "pseudo-class-hover" "description": "Highlights when hovering." "name": ":disabled" "escaped": "pseudo-class-disabled" "description": "Dims the button when disabled." "name": ".primary" "escaped": "primary" "description": "Indicates button is the primary action." "name": ".smaller" "escaped": "smaller" "description": "A smaller button" "markup": "example": "<button>This is a button</button>" "escaped": "<button>This is a button</button>"
Doki API
Doki was built on top of DSS
class Doki(sourceFile)
The constructor accept any patter from glob or an array of files.
const Doki = ;let doki = 'css/*.css';
doki.out([options])
options
={}
- return
Array
let doki = 'css/*.css';let output = doki;
doki.parser(name, cb(i, line, block))
DSS, by default, includes 4 parsers for the name
, description
, state
and markup
of a comment block. You can add to, or override, these defaults by registering a new parser
.
let doki = 'css/*.css';doki;let output = doki;
Styleguide Documentation
@name
/* @name Button */
@description
/* @description Your standard form button. */
@state
/* @state :hover - Highlights when hovering. */
@markup
/** * @markup * <button>This is a button</button> */
License
MIT © Filipe LInhares