node package manager

gulp-docco

gulp-docco (a.k.a "Gulco citron")

NPM version Build Status Coverage Status Dependency Status Code Climate

docco plugin for gulp

WARNING

This is an early release - if you find bugs, please say so.

TL;DR

Install gulp-docco as a development dependency:

npm install --save-dev gulp-docco

Then, add it to your gulpfile.js:

var docco = require("gulp-docco");
 
gulp.src("./src/*.js")
  .pipe(docco())
  .pipe(gulp.dest('./documentation-output'))

That's it.

API

options

Additionally, we support passing an options object following the docco syntax:

var docco = require("gulp-docco");
 
gulp.src("./src/*.js")
  .pipe(docco(options))
  .pipe(gulp.dest('./documentation-output'))

Mainly of interest are the various embedded layouts (parallel, linear, classic), and custom template support.

Caveats?

We bypass some of docco internals in order to prevent it from manipulating files on its own - if something is broken, say so!

License

MIT License