README.md

gulp-documentation

Use gulp with documentation to generate great documentation for your JavaScript projects.

name	description
options	output options
options.format	either 'html', 'md', 'json', or 'docset'
options.filename	custom filename for md or json output

Returns stream.Transform

Installation

$ npm install --save-dev gulp-documentation

Example

var documentation = require('gulp-documentation'),
    gulp = require('gulp');

gulp.task('documentation', function () {

  gulp.src('./index.js')
    .pipe(documentation({ format: 'md' }))
    .pipe(gulp.dest('md-documentation'));

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

  gulp.src('./index.js')
    .pipe(documentation({ format: 'json' }))
    .pipe(gulp.dest('json-documentation'));

});