gulp-jsduck2

gulp-jsduck2

A gulp plugin for jsduck

Installing

Add gulp-jsduck2 as a dev dependency:

$ npm install --save-dev gulp-jsduck2;

You'll also need to install the JSDuck gem:

$ gem install jsduck;

Previous versions of the jsduck module that this module depends on installed it by default, but since version 1.0.0 of both this module and jsduck that no longer happens.

Usage

gulp-jsduck2 can be used similarly to other Gulp plugins. Just pipe files to it and it will document them:

var gulp = require("gulp");
var GJSDuck = require("gulp-jsduck");
var gjsduck = new GJSDuck(["--out", "docs"]);

gulp.task("default", function () {
  gulp.src("src/**.js").pipe(gjsduck.doc());
});