Home

Welcome to the jadoc wiki!

This wiki is only for contributors to jadoc. For usage, seethe user docs template

home 0

Some markdown trial:

Tips on displaying files on Github

http://www.stat.ubc.ca/~jenny/STAT545A/topic13_make-browsing-GitHub-repo-more-rewarding.html

Reflinks

This is a reflink:

this is a possible variable? : #{myvar}

Alternatives for tech docs

Along with each release there should be a publication of the current wiki snapshot to the corresponding Github pages project repository

Problems:

• Github wikis are clunky, they are certainly ill suited for long technical documents. And we will have many to publish, along many repositories.
• markdown to html conversion may be not so easy.

Possible HTML5 only solutions:

ReSpec

• it's the system also used for W3C specs
• lightweight
• practically browser only
• should automatically generate TOC

HTMLBook

• specs endorsed by O'Reilly to produce digital books
• young
• still no tool to generate TOC