Jazzy vs RDoc
Jazzy
github.comRDoc
ruby.github.ioSide by side
| Figure | Jazzy | RDoc |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| Self-hosted | — | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 7.7 (#14) | 8.1 (#8) |
| Purpose | Jazzy is a command-line utility that generates documentation for Swift and Objective-C. | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. |
| Support | The README links to installation troubleshooting guidance and asks users to report code-of-conduct concerns to [email protected]. | The project directs users to CONTRIBUTING.md for filing bug reports. |
Plans
In their own words
RDoc
RDoc is free software for producing Ruby project documentation as HTML pages and command-line reference output. The `rdoc` command generates documentation, while `ri` displays it. It processes Ruby, C, and RBS source files, plus RDoc markup, Markdown, RD, and TomDoc documents. RBS declarations can describe classes, modules, methods, attributes, and constants, and can add comments or type signatures to matching Ruby source documentation. A local preview server watches source files and refreshes the browser after changes. It uses Ruby’s built-in TCPServer and needs no external gems, but provides neither HTTPS nor HTTP/2 and is intended only for local previews. RDoc reports documentation coverage with `rdoc -C`, or includes parameter names with `rdoc -C1`. Generation can be automated through Rake or the RDoc API. Aliki is the default theme; Darkfish is deprecated. Ruby 3.2.0 or newer is required for the current gem.