Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Javascript API documenting framework with lightweight mark-up

I'm seeking a Javascript API documenting framework with features similar to JSDoc, but would use easy-to-type restructured text or markdown in the code comments (not html)

Bonus: would integrate well with Sphinx. However, I don't want to maintain separate documentation, but generate API documentation from comments.

http://code.google.com/p/jsdoc-toolkit/

like image 544
Mikko Ohtamaa Avatar asked Aug 11 '11 20:08

Mikko Ohtamaa


3 Answers

I finally found JSDuck the most suitable for the task:

https://github.com/senchalabs/jsduck

like image 146
Mikko Ohtamaa Avatar answered Nov 16 '22 08:11

Mikko Ohtamaa


InvisibleJS supports markdown and a variety of other formats.

Also take a look at docco.

like image 3
Mrchief Avatar answered Nov 16 '22 07:11

Mrchief


JSDoc 3 now supports markdown by a plugin. You can configure markdown support by adding the line

"plugins": [ "plugins/markdown" ],

to your configuration JSON file.

Now, starting JSDoc with -c conf.json will enable markdown support.

like image 1
pvorb Avatar answered Nov 16 '22 08:11

pvorb