https://github.com/webcaetano/gulp-jsdoc-json
Turns jsdocs comments into a single .json file.
https://github.com/webcaetano/gulp-jsdoc-json
Last synced: 25 days ago
JSON representation
Turns jsdocs comments into a single .json file.
- Host: GitHub
- URL: https://github.com/webcaetano/gulp-jsdoc-json
- Owner: webcaetano
- License: mit
- Created: 2016-05-23T00:30:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-04T19:19:22.000Z (almost 10 years ago)
- Last Synced: 2025-01-29T19:18:24.883Z (over 1 year ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# gulp-jsdoc-json [![npm][npm-img]][npm-url] [![travis][travis-img]][travis-url]
[npm-img]: https://img.shields.io/npm/v/gulp-jsdoc-json.svg?style=flat-square
[npm-url]: https://npmjs.org/package/gulp-jsdoc-json
[travis-img]: https://img.shields.io/travis/webcaetano/gulp-jsdoc-json.svg?style=flat-square
[travis-url]: https://travis-ci.org/webcaetano/gulp-jsdoc-json
Gulp plugin to extract json from jsdoc comments.
## Install
```
npm install gulp-jsdoc-json
```
## Usage
```javascript
return gulp.src('test/*.js') // get all .js files with jsdoc comments
.pipe(jsdocJson({
output:'data.json'
}))
.pipe(gulp.dest('./docs')); //output data.json
```
## Special thanks
[@75lb](https://github.com/75lb) for made [jsdoc-api](https://github.com/jsdoc2md/jsdoc-api)