A docco plugin for Gulp
docco plugin for gulp
This is an early release - if you find bugs, please say so.
gulp-docco as a development dependency:
npm install --save-dev gulp-docco
Then, add it to your
var docco = require"gulp-docco";gulpsrc"./src/*.js"pipedoccopipegulpdest'./documentation-output'
Additionally, we support passing an options object following the docco syntax:
var docco = require"gulp-docco";gulpsrc"./src/*.js"pipedoccooptionspipegulpdest'./documentation-output'
Mainly of interest are the various embedded layouts (parallel, linear, classic), and custom template support.
We bypass some of docco internals in order to prevent it from manipulating files on its own - if something is broken, say so!