Home

mwbrooks edited this page Jan 15, 2011 · 7 revisions
Clone this wiki locally

Background

Based on the original “jodoc” script from the Jo JavaScript framework project, joDoc is a simple markdown-based documentation system. It works with markdown files, markdown comments embedded in source code, and even HTML snippet files (great for working with other documentation systems). One of the core features is the auto-linker, which turns any text within an H1 tag into a linkable keyword. Check out the examples below to get a feel for what is possible.

Examples

Simple single-page example:
http://joapp.com/jo

Multi-page example with custom table of contents in a frameset:
http://joapp.com/jotest/jotest

PhoneGap:
http://docs.phonegap.com/

XUI Documentation:
http://xuijs.com/

Contributors

Dave Balmer (Twitter @balmer)
Dan Freedman (Twitter @danfreedman)