Home

Hanna—a better RDoc template

Hanna is an RDoc template that scales. It’s implemented in Haml, making the sources clean and readable. It’s built with simplicity, beauty and ease of browsing in mind.

Hanna is available from GitHub:

gem install mislav-hanna

After installing, see the usage examples in the README.

Too see something very cool being done with Hanna, go to Rails edge API documentation on my server. Styles here are a bit tweaked to add color (Hanna is by default mostly gray) and you will notice that it features a very nice class browser (powered by Shrubbery).

Why the name “Hanna”?

I wanted to give a beautiful template a beautiful girl’s name. Evan Weaver called his template Allison. I dated a girl named Ana at the time, so Haml + Anna = Hanna.

Last edited by mislav, 2 months ago
Versions: