gulp-doxx
Doxx documentation generator for gulp.
Install
npm install gulp-doxx
Configure
var gulp = gulpDoxx = ; gulp;
Options
title
Type: String
The title of your project
Default: Title not set
urlPrefix
Type: String
Default: null
Prefix to be used for generating links in menu.
Examples
Without urlPrefix
menu link could look like:
script.js
Same link with urlPrefix
set to ./docs
:
script.js
Same link with urlPrefix
set to http://my-docs-server.io
:
script.js
template
Type: String
Default: undefined
Path to jade template to be used to generate result.
If not set, default doxx template will be used.
Run
gulp docs