Skip to content

compodoc/gulp-compodoc

Repository files navigation

gulp-compodoc

Compodoc plugin for gulp

Compodoc: The missing documentation tool for your Angular application
npm badge npm dependencies npm devDependencies MIT badge

The missing documentation tool for your Angular application

Compodoc: 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

About

Compodoc plugin for gulp

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •