YARD

Spec sheet

Purpose

YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats.Read 8 Oct 2026 · yardoc.org

Audience

The site says YARD is used by projects including Addressable, DataMapper, Haml, MongoDB, Puppet, and Sass.Read 8 Oct 2026 · yardoc.org

Integrations

The site names plugins supporting RSpec, DataMapper, and Sinatra.Read 8 Oct 2026 · yardoc.org

Support

The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch.Read 8 Oct 2026 · yardoc.org

License

The site states that YARD uses the MIT License.Read 8 Oct 2026 · yardoc.org

Extensibility

Developers can extend YARD with plugins to handle custom Ruby syntax and constructs.Read 8 Oct 2026 · yardoc.org

Installation

The site instructs users to install YARD with the RubyGems command gem install yard.Read 8 Oct 2026 · yardoc.org

Local server

YARD can serve project or installed-gem documentation locally, with dynamic search and live reloading.Read 8 Oct 2026 · yardoc.org

Markup support

The project README says YARD includes a built-in renderer for RDoc and Markdown.Read 8 Oct 2026 · github.com

Metadata tags

YARD uses @tag syntax to document details such as parameters, types, return values, exceptions, and deprecation.Read 8 Oct 2026 · yardoc.org

Notable limit

The README says YARD's yri command currently works with the active project but not the Ruby standard library or core libraries.Read 8 Oct 2026 · github.com

Raw data output

YARD can output documented objects as raw data for later generation in custom formats such as YAML.Read 8 Oct 2026 · yardoc.org

RDoc compatibility

YARD is designed to work with RDoc-formatted documentation strings.Read 8 Oct 2026 · yardoc.org

Template customization

YARD includes a templating system for customizing generated documentation.Read 8 Oct 2026 · yardoc.org

Plans and prices

Every YARD plan and price →

Where Specifiction places it

• Documentation Generators#29 of 377.1