gulp-documentation
Use gulp with documentation to generate great documentation for your JavaScript projects.
Installation
$ npm install --save-dev gulp-documentation
API
documentation
Documentation stream intended for use within the gulp system.
Parameters
format
string? format - one of 'html', 'md', or 'json' (optional, defaultmd
)options
Object documentation options - the same as given to documentationoptions.filename
string custom filename for md or json output
formatterOptions
Object output options - same as given to documentationformatterOptions.name
Object if format is HTML, specifies the name of the project
Examples
var gulpDocumentation = ;var gulp = ;// Out of the box, you can generate JSON, HTML, and Markdown documentationgulp; // Generating a pretty HTML documentation sitegulp; // Generating raw JSON documentation outputgulp; // 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; // If you're using HTML documentation, you can specify additional 'name'// and 'version' optionsgulp; // Document non-JavaScript files with JSDoc comments using polyglot: truegulp;
Returns stream.Transform