FormidableLabs/gulp-mdox

Name: gulp-mdox

Owner: Formidable

Description: Convert JsDoc comments to Markdown.

Created: 2014-04-28 22:45:27.0

Updated: 2017-01-02 05:00:00.0

Pushed: 2014-08-22 22:41:41.0

Homepage: null

Size: 188

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

gulp-mdox

Convert JsDoc comments to Markdown.

Install

Install with 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.

gulp = require("gulp"),
ox = require("gulp-mdox");

.task("docs", function () {
lp
.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)

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 Tools

Other alternative tools:

• gulp-markdox: markdox plugin for gulp