https://github.com/compodoc/gulp-compodoc
Compodoc plugin for gulp
https://github.com/compodoc/gulp-compodoc
Last synced: 5 months ago
JSON representation
Compodoc plugin for gulp
- Host: GitHub
- URL: https://github.com/compodoc/gulp-compodoc
- Owner: compodoc
- License: mit
- Created: 2016-12-13T05:48:46.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2018-11-28T10:20:27.000Z (over 7 years ago)
- Last Synced: 2025-09-15T03:49:36.154Z (10 months ago)
- Language: TypeScript
- Size: 53.7 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-compodoc
[Compodoc](https://github.com/compodoc/compodoc) plugin for gulp
The missing documentation tool for your Angular application
## Install
```
$ npm install --save-dev @compodoc/gulp-compodoc
```
## Usage
```js
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](https://github.com/compodoc/compodoc) are available. The list is available [here](https://github.com/compodoc/compodoc#usage).
## License
Everything in this repo is MIT License unless otherwise specified.
MIT © 2016 - [Vincent Ogloblinsky](http://www.vincentogloblinsky.com)