gulp-api-doc
Generates a RESTful web API Documentation with apiDoc.
Installation
npm install --save-dev gulp-api-doc
Usage
Generate documentation for the entire controllers
directory.
const gulp = ;const apidoc = ; gulp;
Generate documentation for all the controllers
, except for the ones in the auth
folder and don't parse markdown statements.
gulp;
Options
- template: Directory with the template files.
- debug (false): Show debug output.
- silent (false): Hide log output.
- markdown (true): Parse markdown statements in the documentation.
- marked
- gfm (true): Github flavored markdown.
- tables (true): Enables Github flavored markdown tables. This option requires
gfm
to be true. - breakes (false): Enabled Github flavored markdown line breaks.
- pedantic (false): Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
- sanitize (false): Sanitize the output. Ignore any HTML that has been input.
- smartLists (true): Use smarter list behaviour than the original markdown.
- smartypants (false): Use "smart" typographic punctuation for things like quotes and dashes.
License (MIT)
MIT © Sam Verschueren