gulp-esdoc-stream

gulp-esdoc-stream

ESDoc stream for gulp.

Usage

const esdoc = require( 'gulp-esdoc-stream' );

Basic, fast usage. Will pipe every file through ESDoc. Only the paths are necessary.

gulp.task( "default", function() {
	return gulp.src( "src/**/*.js", { read: false } )
		.pipe( esdoc( 'docs' ) )
	;
});

Basic, slower usage. Will output the documentation on the docs folder, and keep on piping the js files.

gulp.task( "default", function() {
	return gulp.src( "src/**/*.js" )
		.pipe( esdoc( 'docs' ) )
		.pipe( gulp.dest( "build" ) )
	;
});

Pipes the generated files from the documentation.

gulp.task( "default", function() {
	return gulp.src( "src/**/*.js", { read: false } )
		.pipe( esdoc() )
		.pipe( gulp.dest( "docs" ) )
	;
});