Home | Download | User guide | RDoc | Issue tracker | Source Code | Mailing lists | Licence

Welcome!

Rote is a simple page-based template system that was written to make it easier to author and maintain non-dynamic websites and offline documentation. Rote provides a simple commandline or Rake based build for your pages, with page rendering (optionally supporting RDoc formatting, Textile and Markdown with RedCloth and ruby code with ERB), layout, and general documentation / website build tasks.

Features

Rote offers the following major features:

* Simple set-up based on page templates and sections.
* ERB, Textile, Markdown and RDoc supported out of the box.
* Multiple configurable layouts apply boilerplate to your pages.
* Apply arbitrary Ruby code across all documentation, a subset, or individual pages.
* Can be used standalone (from the command-line) or within Rake as a custom task library.
* Supports any (text-based) format, while providing utilities and helpers for common formats.
* Flexible filtering with several standard filters and the ability to implement your own in a few lines of Ruby.
* Low-overhead monitoring functionality allows documentation to be automatically re-rendered, and custom processing done, whenever the source changes.

Rote is somewhat similar to WebGen in intent, though the two are quite different in implementation. WebGen provides a richer environment geared more toward end-user websites and content publishing, whereas Rote’s implementation as an extension to Rake reflects a bias toward software documentation and general textual templating.

See the User guide and RDoc for usage information.

Download?

You can get Rote via RubyGems if you have it:

* gem install -r rote

Alternatively, you can download tarball / zip packages if you don’t:

From Git

You can also grab the latest code from our GitHub page .

The master branch has the most up to date working development code while the latest release can be found on the appropriate tag for that version. Although every effort is made to ensure that this development code works, it cannot of course be guaranteed to be complete or bug free. If that’s okay with you (maybe you’re pretty happy-go-lucky in general…) then see our GitHub page for everything you need to get going with the Git version.