Skip to content

Commit ca06ad9

Browse files
committed
feat(app): root files
1 parent d61c927 commit ca06ad9

File tree

3 files changed

+92
-0
lines changed

3 files changed

+92
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
1+
<p align="center">
2+
<img src="https://avatars3.githubusercontent.com/u/23202313" alt="Compodoc: The missing documentation tool for your Angular application" width="226">
3+
<br>
4+
<a href="https://www.npmjs.com/package/gulp-compodoc"><img src="https://badge.fury.io/js/gulp-compodoc.svg" alt="npm badge"></a>
5+
<a href="https://david-dm.org/compodoc/gulp-compodoc"><img src="https://david-dm.org/compodoc/gulp-compodoc.svg" alt="npm dependencies"></a>
6+
<a href="https://david-dm.org/compodoc/gulp-compodoc?type=dev"><img src="https://david-dm.org/compodoc/gulp-compodoc/dev-status.svg" alt="npm devDependencies"></a>
7+
<a href="http://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
8+
</p>
9+
110
# gulp-compodoc
211
Compodoc plugin for gulp
12+
13+
## Install
14+
15+
```
16+
$ npm install --save-dev gulp-compodoc
17+
```
18+
19+
20+
## Usage
21+
22+
```js
23+
const gulp = require('gulp'),
24+
compodoc= require('gulp-compodoc');
25+
26+
gulp.task('default', () => {
27+
gulp.src('src/**/*.ts')
28+
.pipe(compodoc())
29+
);
30+
```
31+
32+
33+
## API
34+
35+
### compodoc([options])
36+
37+
#### options
38+
39+
##### foo
40+
41+
Type: `boolean`<br>
42+
Default: `false`
43+
44+
Lorem ipsum.
45+
46+
47+
## License
48+
49+
Everything in this repo is MIT License unless otherwise specified.
50+
51+
MIT © 2016 - [Vincent Ogloblinsky](http://www.vincentogloblinsky.com)

package.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "gulp-compodoc",
3+
"version": "0.0.1",
4+
"description": "Compodoc plugin for gulp",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://[email protected]/compodoc/gulp-compodoc.git"
12+
},
13+
"keywords": [
14+
"gulp",
15+
"gulpplugin",
16+
"angular2",
17+
"angular",
18+
"documentation",
19+
"components",
20+
"module",
21+
"graph",
22+
"dependencies",
23+
"markdown"
24+
],
25+
"author": "Vindent Ogloblinsky ([email protected])",
26+
"license": "MIT",
27+
"bugs": {
28+
"url": "https://github.com/compodoc/gulp-compodoc/issues"
29+
},
30+
"homepage": "https://github.com/compodoc/gulp-compodoc#readme",
31+
"engines": {
32+
"node": ">=5.10.0"
33+
},
34+
"dependencies": {
35+
"gulp-util": "^3.0.7",
36+
"through2": "^2.0.1",
37+
"compodoc": "^0.0.23"
38+
},
39+
"devDependencies": {
40+
"gulp": "^3.9.1"
41+
}
42+
}

0 commit comments

Comments
 (0)