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…
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.
Written by
Related posts
Celebrating the GitHub Awards 2024 recipients 🎉
The GitHub Awards celebrates the outstanding contributions and achievements in the developer community by honoring individuals, projects, and organizations for creating an outsized positive impact on the community.
New from Universe 2024: Get the latest previews and releases
Find out how we’re evolving GitHub and GitHub Copilot—and get access to the latest previews and GA releases.
Bringing developer choice to Copilot with Anthropic’s Claude 3.5 Sonnet, Google’s Gemini 1.5 Pro, and OpenAI’s o1-preview
At GitHub Universe, we announced Anthropic’s Claude 3.5 Sonnet, Google’s Gemini 1.5 Pro, and OpenAI’s o1-preview and o1-mini are coming to GitHub Copilot—bringing a new level of choice to every developer.