On the recordRead 8 Oct 202614 facts
YARD
Plans and prices
YARD
Free
Ruby documentation tool · installable with RubyGems · MIT license
Read 8 Oct 2026 · yardoc.org
On the record
- Audience
- The site says YARD is used by projects including Addressable, DataMapper, Haml, MongoDB, Puppet, and Sass.yardoc.org · read 8 Oct 2026
- Extensibility
- Developers can extend YARD with plugins to handle custom Ruby syntax and constructs.yardoc.org · read 8 Oct 2026
- Installation
- The site instructs users to install YARD with the RubyGems command gem install yard.yardoc.org · read 8 Oct 2026
- Integrations
- The site names plugins supporting RSpec, DataMapper, and Sinatra.yardoc.org · read 8 Oct 2026
- License
- The site states that YARD uses the MIT License.yardoc.org · read 8 Oct 2026
- Local server
- YARD can serve project or installed-gem documentation locally, with dynamic search and live reloading.yardoc.org · read 8 Oct 2026
- Markup support
- The project README says YARD includes a built-in renderer for RDoc and Markdown.github.com · read 8 Oct 2026
- Metadata tags
- YARD uses @tag syntax to document details such as parameters, types, return values, exceptions, and deprecation.yardoc.org · read 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.github.com · read 8 Oct 2026
- Purpose
- YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats.yardoc.org · read 8 Oct 2026
- Raw data output
- YARD can output documented objects as raw data for later generation in custom formats such as YAML.yardoc.org · read 8 Oct 2026
- RDoc compatibility
- YARD is designed to work with RDoc-formatted documentation strings.yardoc.org · read 8 Oct 2026
- Support
- The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch.yardoc.org · read 8 Oct 2026
- Template customization
- YARD includes a templating system for customizing generated documentation.yardoc.org · read 8 Oct 2026
