README
gulp-compodoc
Compodoc plugin for gulp
The missing documentation tool for your Angular application
Install
$ npm install --save-dev @compodoc/gulp-compodoc
Usage
const gulp = require('gulp'),
compodoc = require('@compodoc/gulp-compodoc');
gulp.task('default', () => {
return gulp.src('src/**/*.ts').pipe(
compodoc({
output: 'documentation',
tsconfig: 'src/tsconfig.json',
serve: true
})
);
});
API
compodoc(options)
options
All options from compodoc are available. The list is available here.
License
Everything in this repo is MIT License unless otherwise specified.
MIT © 2016 - Vincent Ogloblinsky