EVERYTHING XIAOMI
Get listed

YARD

YARD is a free Linux documentation generator for Ruby projects.

Place
#27 of 37
Score
5.8
YARD's website

What YARD is

YARD is a free Linux documentation generator for Ruby projects. It reads Ruby, RDoc, and Markdown input and produces API reference documentation, including HTML and YAML output. Its @tag syntax documents parameters, types, return values, exceptions, and deprecation, while its renderer handles RDoc and Markdown documentation strings. Developers can customize generated results with templates, extend support for custom Ruby syntax through plugins, or output documented objects as raw data for formats such as YAML. YARD can serve project or installed-gem documentation locally with dynamic search and live reloading. The site names plugins for RSpec, DataMapper, and Sinatra. Installation uses the RubyGems command gem install yard, and the project uses the MIT License. YARD has no paid plan or free trial. Its yri command works with the active project but not Ruby’s standard library or core libraries.

Good

  • Free Ruby documentation generator
  • Generates HTML and YAML
  • Supports RDoc and Markdown
  • Local server includes search and live reload
  • Extensible through plugins and templates

Watch out

  • Linux platform listed
  • yri excludes Ruby standard and core libraries
  • Requires RubyGems installation
  • No free trial

Who it suits

YARD suits Ruby developers who need generated API references, local documentation browsing, or customized output. It is also relevant to projects using RDoc or Markdown documentation strings.

Verdict

YARD provides a free, extensible way to generate and browse Ruby documentation. Its plugin and template options add flexibility, while the yri limitation affects standard and core library references.

Plans and prices

From YARD's own pricing page, checked 8 Oct 2026.

All about pricing
PlanPriceWhat it gives you
YARDFreeRuby documentation tool · installable with RubyGems · MIT license · Free; the page lists no paid plans.

The facts

Each one read from YARD's own pages, with the date it was checked.

What it does

Audience
The site says YARD is used by projects including Addressable, DataMapper, Haml, MongoDB, Puppet, and Sass.checked 8 Oct 2026
Extensibility
Developers can extend YARD with plugins to handle custom Ruby syntax and constructs.checked 8 Oct 2026
Installation
The site instructs users to install YARD with the RubyGems command gem install yard.checked 8 Oct 2026
Integrations
The site names plugins supporting RSpec, DataMapper, and Sinatra.checked 8 Oct 2026
License
The site states that YARD uses the MIT License.checked 8 Oct 2026
Local server
YARD can serve project or installed-gem documentation locally, with dynamic search and live reloading.checked 8 Oct 2026
Markup support
The project README says YARD includes a built-in renderer for RDoc and Markdown.checked 8 Oct 2026
Metadata tags
YARD uses @tag syntax to document details such as parameters, types, return values, exceptions, and deprecation.checked 8 Oct 2026
Notable limit
The README says YARD's yri command currently works with the active project but not the Ruby standard library or core libraries.checked 8 Oct 2026
Purpose
YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats.checked 8 Oct 2026
Raw data output
YARD can output documented objects as raw data for later generation in custom formats such as YAML.checked 8 Oct 2026
RDoc compatibility
YARD is designed to work with RDoc-formatted documentation strings.checked 8 Oct 2026
Support
The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch.checked 8 Oct 2026
Template customization
YARD includes a templating system for customizing generated documentation.checked 8 Oct 2026

Alternatives to YARD

All alternatives
  1. 1Scalar logo

    Scalar

    Free planOpen sourceWebAPILinuxmacOS
    8.4From $150 a month
    Visit
  2. 2Redocly logo

    Redocly

    WebAPIExtension
    7.0From $10 a month
    Visit
  3. 3Sphinx logo

    Sphinx

    Free planWebAPILinuxmacOS
    7.0Free plan
    Visit
  4. 4Asciidoctor logo

    Asciidoctor

    Free planWebAPIExtensionLinux
    6.9Free plan
    Visit
  5. 5

    JSON Schema for Humans

    Free planLinuxmacOSSelf-hostedWindows
    6.5Free plan
    Visit
  6. 6

    StepShot

    Free planmacOS
    6.5CN¥269 one-time
    Visit