ApiDoc-markdown


ApiDoc markdown creates a documentation from API descriptions in your source code.

> It uses apidoc to convert inline documentation comments into json schema and later convert it to markdown.

Uses the apidoc-core library.

Documentation: apidocjs.com

Installation

``bash
$ npm install -g @mathieu_andrade/apidoc-markdown
`

Usage

Add some apidoc comments anywhere in your source code:

`javascript
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id User's unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
`

Now generate the documentation from src/ into doc/.

`bash
$ apidoc-markdown -i src/ -o doc/
`

$3

`bash
-f --file-filters RegEx-Filter to select files that should be parsed (multiple -f can be used). (default: [])
-e, --exclude-filters RegEx-Filter to select files / dirs that should not be parsed (many -e can be used). (default: [])
-i, --input Input/source dirname. (default: [])
-o, --output

Output dirname. (default: "./doc/")
-t, --template