Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR. Learn more →
Top 23 Ruby Documentation Projects
-
Search API documentation effortlessly with DevDocs.
-
Nutrient
Nutrient - The #1 PDF SDK Library. Bad PDFs = bad UX. Slow load times, broken annotations, clunky UX frustrates users. Nutrient’s PDF SDKs gives seamless document experiences, fast rendering, annotations, real-time collaboration, 100+ features. Used by 10K+ devs, serving ~half a billion users worldwide. Explore the SDK for free.
-
Gollum
A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
Depends on your target user. If you want something really simple for developers, https://github.com/gollum/gollum is pretty neat (is what powers the Wiki system on GitHub), while if you want something simple for people who aren't developers, something like Mediawiki would fit better. Although Mediawiki requires a database, you can use SQLite (which is basically a file on disk as a DB) for it.
Dokuwiki is also a neat old-school alternative that basically treats files on disk as articles/pages, so no (other) DB needed.
-
GitHub Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-
-
Asciidoctor
:gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
The problem with asciidoc is that it doesn't support nesting. Markdown allows you to nest constructs as much as you want using syntax that are easy to use for both humans and documentation-generating applications.
The asciidoc developers don't seem to consider this an important issue: https://github.com/asciidoctor/asciidoctor/issues/1121
While asciidoc has some nice constructs, this made it a no go the last time I was looking for a documentation language.
-
-
-
CodeRabbit
CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.
-
-
-
-
-
> man pages are much more difficult to produce than plain help text
They're absolutely trivial to generate these days, gone are the days of having to deal with roff, you can write a quite dumb markdown file and produce a man page out of it in short order.
https://github.com/sunaku/md2man/blob/master/EXAMPLE.markdow...
https://github.com/rtomayko/ronn/blob/master/man/ronn-format...
-
-
Project mention: Ruby's official documentation just got a new look | news.ycombinator.com | 2024-08-25
This is false. You can see exactly what was changed: https://github.com/ruby/rdoc/pull/1157/files
-
-
-
fab-manager
Fab-Manager is the FabLab management solution. It provides a comprehensive, web-based, open-source tool to simplify your administrative tasks and your marker's projects.
-
-
pie-cookbook
PIE is an experiment. We've been everything from a coworking space to a community hub to an early stage startup accelerator. Now, we're open sourcing everything we've learned from nearly a decade of helping startups.
-
allourideas.org
allourideas allows groups to collect and priorize information in an open, democratic, and efficient process.
-
diaspora_federation
A library that provides functionalities needed for the diaspora* federation protocol.
-
-
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
Ruby Documentation discussion
Ruby Documentation related posts
-
Markdown's Big Brother: Say Hello to AsciiDoc
-
Ruby "Thread Contention" Is Simply GVL Queuing
-
11 Must-Know Websites Every Developer Should Bookmark
-
10 Websites Every Web Developer Should Explore**
-
10 Websites every Web developer should at least look
-
5 must-know web tools for you next websites
-
Asciidoctor: A fast text processor and publishing toolchain
-
A note from our sponsor - CodeRabbit
coderabbit.ai | 14 Feb 2025
Index
What are some of the best open-source Documentation projects in Ruby? This list will help you:
# | Project | Stars |
---|---|---|
1 | devdocs | 35,709 |
2 | Gollum | 13,933 |
3 | GitHub Changelog Generator | 7,424 |
4 | jazzy | 7,361 |
5 | Asciidoctor | 4,931 |
6 | Annotate | 4,447 |
7 | Apipie | 2,484 |
8 | Hologram | 2,162 |
9 | YARD | 1,948 |
10 | jsduck | 1,503 |
11 | rspec_api_documentation | 1,452 |
12 | Ronn | 1,366 |
13 | grape-swagger | 1,091 |
14 | RDoc | 852 |
15 | bluedoc | 626 |
16 | Inch | 517 |
17 | fab-manager | 233 |
18 | rubychanges | 197 |
19 | pie-cookbook | 165 |
20 | allourideas.org | 160 |
21 | diaspora_federation | 101 |
22 | oas_rails | 79 |
23 | Apidoco | 72 |