documentation(options, options.format, options.filename)

Documentation stream intended for use within the gulp system.

parameter	type	description
options	Object	output options
options.format	string	either 'html', 'md', 'json', or 'docset'
options.filename	string	custom filename for md or json output

Returns

Examples

var documentation = require('./'),
    gulp = require('gulp');

gulp.task('documentation', function () {
  gulp.src('./index.js')
    .pipe(documentation({
      format: 'html'
    }))
    .pipe(gulp.dest('documentation'));
});