README.md

gulp-doxdox

doxdox plugin for gulp

Usage

First, install gulp-doxdox as a development dependency:

npm install --save-dev gulp-doxdox

Then, add it to your gulpfile.js:

var doxdox = require("gulp-doxdox");

gulp.src("./src/**/*.js")
  .pipe(doxdox({
    "title": "Untitled Project",
    "layout": "markdown"
  }))
  .pipe(rename("documentation.md"))
  .pipe(gulp.dest("./dist"));

API

doxdox(options)

options.layout

Type: String
Default: "markdown"

Layout to render the documentation with.

• `"Markdown"``
• `"Bootstrap"``
• Custom Handlebars template file ("template.hbs")

options.description

Type: String
Default: ""

options.title

Type: String
Default: "Untitled Project"

License

MIT License