YARD
Ruby documentation generation tool that builds API documentation from source comments and serves it with a local documentation server.
YARD is a documentation generation tool for Ruby code. It is installed as a gem with gem install yard, and the yardoc command generates documentation from a project’s source files, by default from lib/**/*.rb. The yard server command serves the generated documentation for a project or for installed gems, and reloads changed files while it runs.
Worth knowing
The README describes the server as a preview for a project under development. It does not describe publishing the generated output.
Identity
- Status
- Active
- Maintainer
- Loren Segal4
- Maintained by
- Individual
- First release
- 20096
Rendering and deploy
Releases
Adoption
Sources
- 2026-10-23: links, Written in, GitHub stars
api.github.com/repos/lsegal/yard - 2026-10-23: links
yardoc.org/ - 2026-10-23: links, Categories, Install with, Runs as, License, License model
github.com/lsegal/yard/blob/main/README.md - 2026-10-23: Maintainer
raw.githubusercontent.com/lsegal/yard/main/LICENSE - 2026-10-23: Runtime
rubygems.org/api/v1/gems/yard.json - 2026-10-23: Minimum runtime, First release
rubygems.org/api/v1/versions/yard.json - 2026-10-23: Current major version, Last release
api.github.com/repos/lsegal/yard/releases/latest - 2026-10-23: Contributors
api.github.com/repos/lsegal/yard/contributors - 2026-10-25: Dependent repositories, Dependent packages
packages.ecosyste.ms/api/v1/registries/rubygems.org/packages/yard