Generate API documentation in markdown from apiDoc data.
npm install @mathieu_andrade/apidoc-markdownbash
$ 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 `
> Available templates can be found in templates directory.
Support
Please create a new issue if you have a suggestion/question or if you found a problem/bug.
Contributing
ApiDoc-markdown is a collaborative project. Pull requests are welcome. Please see the CONTRIBUTING file.
Todo
- [ ] Improve gitbook template
- [ ] Write Automated tests
- [ ] Create a index file with all links of routes
- [ ] Write a example
- [ ] One file per route feature
Don't hesitate to suggest any feature you would like by creating an issue or a pull request.
License
The MIT license
Thanks
- At apiDoc for the awesome apiDoc-core module
- At rigwild` for its huge work on the apiDoc-markdown module