Docup
Another simple javascript to Markdown/HTML documentation generator (NodeJS).
Snapshots
install
npm install docup -g
Usage
-
with gulp
-
with bin
docup ./sample.js ./output/sample.html --title="sample.js document" --type=html --toc=categories --codeUrl=https://github.com/username/project/blob/master/my.js
- with api
var docup = ; var markdown = ;
JS Sample
/** * A Sample Propertie * @type object * @category- * @alias- * @default true * @example samplePropertie = true; **/var samplePropertie = /** * Another Propertie in samplePropertie * @category samplePropertie * @type string **/ inSamplePropertie : 'inner' ; /** * Another Propertie * @type boolean * @category- * @alias- * @default false **/var anotherPropertie = false; /** * A Sample Function * and with markdown: __Bold Text__ * @param args * @param args.arg * @returns return * @returns return.foo * @returns return.bar * @category- * @alias aliasFunction * @example sampleFunction({ arg : 'Hello world!' }) // returns { foo : '1', bar : 2 } **/var { var arg = argsarg ; var returns = foo : '1' bar : 2 ; return returns; }; /** * aliasFunction */var { }