Back to GitHub.com GitHub Support Contact GitHub

Documentation Explosion

RDoc.info is a web service that generates and hosts documentation for your favorite GitHub-hosted Ruby libraries and Rails plugins. Just add a post-commit hook to your project and it’ll take care of updating your API docs every time you push to the remote.

What, not cool enough for your hipster threads? Well it also masquerades as the docs user on GitHub, and auto-publishes your docs directly to GitHub Pages using a familiar theme. There’s more on how this works here. For an example, check the HTTParty docs or visit http://docs.github.com to get started.

Both of these projects are hosted here (and here) on GitHub, so fork away if you have ideas for improvements. Huge kudos to zapnap and jeffrafter for this awesome use of GitHub Pages and for starting this great service for the community.

Have feedback on this post? Let @github know on Twitter.
Need help or found a bug? Contact us.

Subscribe

Discover new ways to build better

Try Marketplace apps free for 14 days

Learn more