0.0.5 • Published 9 years ago
gulp-doxx v0.0.5
gulp-doxx
Doxx documentation generator for gulp.
Install
npm install gulp-doxx
Configure
var gulp = require('gulp'),
gulpDoxx = require('gulp-doxx');
gulp.task('docs', function() {
gulp.src(['**/*.js', 'README.md'], {base: '.'})
.pipe(gulpDoxx({
title: 'My App Title',
urlPrefix: '/docs'
}))
.pipe(gulp.dest('docs'));
});
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:
<a href="script.js.html">script.js</a>
Same link with urlPrefix
set to ./docs
:
<a href="./docs/script.js.html">script.js</a>
Same link with urlPrefix
set to http://my-docs-server.io
:
<a href="http://my-docs-server.io/script.js.html">script.js</a>
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