Plugin for jsdoc-to-markdown. Works in both buffer and streaming modes.
If you intend to use this plugin and your code has modules, you must always supply a name with the
In other words
@module will fail,
@module my-module will win.
If the module name is not provided, jsdoc will try to infer it from the filename of the module. However, gulp deals with streams - not files. And that stream could come from anywhere. We do not know the file name so we cannot infer the module name - so always supply it. More info here.
One markdown file out per source file in
'use strict'var fs =var gulp =var gutil =var gulpJsdoc2md =var rename =var concat =gulp
Multiple source files in, a single markdown file out
'use strict'var fs =var gulp =var gutil =var gulpJsdoc2md =var concat =gulp
Install this plugin:
$ npm install gulp-jsdoc-to-markdown --save-dev
If using one of the example gulpfiles above you will also need to run:
$ npm i gulp gulp-util gulp-concat gulp-rename --save-dev
© 2014-16 Lloyd Brookes <email@example.com>.