Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.73 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.73 KB

dmd-gitbook

Tips

Build Status

npm version npm downloads

codebeat badge bitHound Overall Score bitHound Dependencies codecov

Plugin for jsdoc2md to produce markdown suitable for gitbook.

To use a plug-in in your project, first install it as a devDependency:

$ npm install dmd-gitbook --save-dev

Then pass the plug-in name to jsdoc2md or dmd:

$ jsdoc2md --plugin dmd-gitbook lib/*.js

License

Please, read the LICENSE file in the root of the repository (or downloaded package).