search

davebalmer / joDoc

Simple, open-ended JavaScript source documentation system based on markdown. joDoc rev 1.0.1 is available. Check Wiki page for some examples.
http://joapp.com/jo#joDoc
Other
62 stars 4 forks source link

Port jodoc to JS #17

Open markc opened 13 years ago

markc commented 13 years ago

Would you be interested in a port of jodoc to javascript using node?

I've been working on a similar inline doc system using markdown but based on showdown.js. I use /*** ... ***/ as special comment markers so it leaves /** ... */ javadoc style comments in place and I mark up the actual live JS files by preprocessing them before passing them to my hacked showdown.js. Your joDoc system is far more mature and complete in that it creates linked indexes. I'm still learning JS and node'isms but I'd love to "port" my markdown js hack to a Jo-like style and include all or most of jodoc functionality as a single file node script (no deps other than the node binary, certainly no perl or ruby etc.)

davebalmer commented 13 years ago

ABSOLUTELY! This is on the roadmap for joDoc, and I'd love to see what you put together because Dan and I haven't started on the node.js port yet.

rtsuk commented 13 years ago

I would try to find some time to help out with porting joDoc to JavaScript. Or even CoffeeScript.

davebalmer commented 13 years ago

Check out Dan Freedman's efforts. He has a good start to a node.js port of joDoc over here http://bit.ly/exwmu4 (Dan is also responsible for beating the perl into shape for this version of joDoc!)

rtsuk commented 13 years ago

Quoting davebalmer
reply@reply.github.com:

Check out Dan Freedman's efforts.

I will, thanks!

Rob