Plugin for jsdoc2md with improved readability and GitHub compatibility.
This plugin borrows from dmd-readable and dmd-bitbucket with additional treatments. No HTML tags are generated within the markdown. Headers are simplified with no nested links. Content links to headers are generated with GitHub style slugs. Reference style links are used instead of being inline.
See the mock file for an example of a generated document.
Install it as a devDependency in target project:
$ npm install @godaddy/dmd --save-dev
Then pass the plugin name to
dmd to generate docs:
$ jsdoc2md --plugin @godaddy/dmd --files lib/*.js