Installation

$ npm install --save-dev gulp-documentation

API

documentation

vargulpDocumentation=require('gulp-documentation');vargulp=require('gulp');//  Out of the box, you can generate JSON, HTML, and Markdown documentationgulp.task('documentation-readme-example',function(){// Generating README documentationreturngulp.src('./index.js').pipe(gulpDocumentation('md')).pipe(gulp.dest('md-documentation'));});// Generating a pretty HTML documentation sitegulp.task('documentation-html-example',function(){returngulp.src('./index.js').pipe(gulpDocumentation('html')).pipe(gulp.dest('html-documentation'));});// Generating raw JSON documentation outputgulp.task('documentation-json-example',function(){returngulp.src('./index.js').pipe(gulpDocumentation('json')).pipe(gulp.dest('json-documentation'));});// Generate documentation for multiple files using normal glob syntax.// Note that this generates one documentation output, so that it can// easily cross-reference and use types.gulp.task('documentation-multiple-files',function(){returngulp.src('./src/*.js').pipe(gulpDocumentation('md')).pipe(gulp.dest('md-documentation'));});// If you're using HTML documentation, you can specify additional 'name'// and 'version' optionsgulp.task('documentation-html-options',function(){returngulp.src('./src/*.js').pipe(gulpDocumentation('html',{},{name:'My Project',version:'1.0.0'})).pipe(gulp.dest('html-documentation'));});// Document non-JavaScript files with JSDoc comments using polyglot: truegulp.task('documentation-for-cplusplus',function(){returngulp.src('./src/*.cpp').pipe(gulpDocumentation('html',{polyglot:true},{name:'My Project',version:'1.0.0'})).pipe(gulp.dest('html-documentation'));});