Skip to content


Subversion checkout URL

You can clone with
Download ZIP
A flexible code documentation specification with human readers in mind.
Latest commit 10370ff @mojombo Fix typo.
Failed to load latest commit information. Autolinking hates period suffix on link. Fix typo.

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 when a new version has been tagged.


This code can be found online at

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.

Something went wrong with that request. Please try again.