This is an early release, and you will likely encounter bugs or limitations.
gulp-yuidoc as a development dependency:
npm install --save-dev gulp-yuidoc
Then, add it to your
var yuidoc = ;gulp;
Calling the parser alone will build a vinyl containing the parsing result of fed files. By default, that vinyl will get named "yuidoc.json", unless you override it with the optional "name" argument.
"options" allows you to speficy yuidoc parsing options (XXX untested).
Reports whatever went wrong with parsing.
If you prefer ugly things, call
yiudoc.yuiReporter() instead (default reporter, which is beautiful, is "stylish", stolen from sindresorhus).
Generates documentation from the result of the parser.
You may pass yuidoc generator options optionally (XXX untested - undocumented).
is a shortcut for: