A flexible code documentation specification with human readers in mind.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
README.md Autolinking hates period suffix on link. May 14, 2011
tomdoc.md Fix typo. May 8, 2012


TomDoc Specification

TomDoc is a code documentation specification that helps you write precise documentation that is nice to read in plain text, yet structured enough to be automatically extracted and processed by a machine.

This is the TomDoc specification text. Work on the specification itself will be done here and then transferred to http://tomdoc.org when a new version has been tagged.


This code can be found online at http://github.com/mojombo/tomdoc

If you'd like to discuss the spec or ask a question, use the GitHub Issues system. To propose a concrete change, create a Pull Request on GitHub.

Development happens on the master branch. To see older version, view this repository at one of the tagged releases.


TomDoc is authored primarily by Tom Preston-Werner.