Convert JsDoc comments to Markdown.
Install
Install with npm
npm install --save-dev gulp-mdox
Example
The JS source for gulp-mdox is read, converted to Markdown, and then inserted
into this README.md document, overwriting the text sections
from ## API to ## Other Tools.
var gulp = require("gulp"),
mdox = require("gulp-mdox");
gulp.task("docs", function () {
gulp
.src("mdox.js")
.pipe(mdox({
src: "./README.md",
name: "README.md",
start: "## API",
end: "## Other Tools"
}))
.pipe(gulp.dest("./"));
});
We eat our dog food!
Note that you don't actually need the src, start and end parameters if
all you want to do is generate a new / completely overwrite an existing
file.
API
exports(opts)
- opts (
Object) Options
- opts.name (
String) Output file name.
- opts.src (
String) Input source markdown file. (optional)
- opts.start (
String) Start marker. (optional)
- opts.end (
String) End marker. (optional)
- opts.github (
Boolean) Use GitHub headings? (optional)
JsDoc-to-Markdown plugin.
Extract JsDoc comments and convert to Markdown.
Other alternative tools:
