This repository was archived by the owner on Sep 25, 2018. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork15
c0b41/gulp-apidoc
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
this package is no longer supported, use thewebpack plugin instead
gulp-apidoc
Generates a RESTful web API Documentationusing theapidoc library.
/path/api/stuff.js:
/** *@api {get} /user/:id Request User information *@apiName GetUser *@apiGroup User * *@apiParam {Number} id Users unique ID. * *@apiSuccess {String} firstname Firstname of the User. *@apiSuccess {String} lastname Lastname of the User. */
Install withnpm
npm install --save-dev gulp-apidocvargulp=require('gulp'),apidoc=require('gulp-apidoc');gulp.task('apidoc',function(done){apidoc({src:"example/",dest:"build/"},done);});
With options:
vargulp=require('gulp'),apidoc=require('gulp-apidoc');gulp.task('apidoc',function(done){apidoc({src:"example/",dest:"build/",template:"template/",debug:true,includeFilters:[".*\\.js$"]},done);});
Other optionscheckout.
The folder to scan for apidoc documentation.
Type:String
The folder where to output the generated files.
Type:StringDefault:doc/
Custom template to use for the output files.
Type:String
Type:StringDefault:options.src
Type:BooleanDefault:false
Type:BooleanDefault:false
Type:BooleanDefault:false
Type:BooleanDefault:false
Type:ArrayDefault:[]