lsegal/yard

Health v2 · maintenance only

Adoption not part of the score

2010 stars · 430 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

YARD is a documentation generation tool for the Ruby programming language, using @tag-style metadata alongside RDoc/Markdown comments. It exports docs to multiple formats, includes a live documentation server, and supports plugins and custom templates for framework DSLs.

Use cases

• generate api documentation for a ruby gem
• document ruby methods with @param and @return type tags
• serve live docs while writing code with yard server
• migrate from rdoc to a better ruby doc tool
• check documentation coverage of a ruby codebase
• write custom doc templates or plugins for rails dsls

When to choose

• you maintain a ruby gem or rails app and need consistent, typed api docs
• you want markdown and rdoc support without extra gems
• you need extensible documentation tooling for custom ruby DSLs

When to avoid

• you document non-Ruby code (except niche plugins)
• you only need a quick README site rather than full API docs
• your team is already standardized on rdoc output and tooling

Facets

library · maturity stable

documentation api-documentation parser cli templating documentation developer-tools programming-languages ruby cli cross-platform ruby doc-generator rdoc yardoc api-docs markup

Member repositories

For agents

markdown · JSON · MCP: product_card(name="lsegal/yard")