RDoc vs Stoplight Elements

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.

Stoplight Elements is a free, open-source set of embeddable web components for building interactive API documentation from OpenAPI documents. It adds customizable left navigation and a three-column layout, while an embedded console lets readers try requests and inspect responses within the documentation. Elements supports OpenAPI, including version 3.1, and JSON Schema. It provides code samples in Curl, Python, Ruby, and Java, and its Stoplight-flavored Markdown supports tabs, callouts, and embedded JSON examples. The components require no build steps and can be used with any framework or HTML project. Documentation can be hosted anywhere, including S3 or GitHub. Elements can point to an OpenAPI document or a Stoplight Workspace and can work with any OpenAPI editor. The listed plan costs nothing and includes OpenAPI 3.1 support, an interactive API console, embedding into an existing CMS, and hosting anywhere. Compared with Elements DevPortal, the product page does not list multiple API listings, mocking, Markdown articles, branch version selection, or search. Stoplight identifies SmartBear as its parent company.