/doc.md

A simple JSDoc documenation tool that creates markdown for node.js modules exports

Primary LanguageJavaScript

#About I created doc.md cause all the jsdoc tools I found were too complex or doesn't do what I wanted. So I decided to create my own jsdoc tool. It creates markdown, this makes it possible to look at the documentation directly in Github.

#Example

A single File test.js -> test.md

[A documentation folder generated with doc.md] (https://github.com/Pita/etherpad-lite/tree/master/doc/jsdoc)

#Install npm install -g doc.md

#Usage

doc.md $SRCFOLDER $DESTFOLDER

#LICENSE Apache License v2 http://www.apache.org/licenses/LICENSE-2.0.html