# YARD

Ruby documentation generation tool that builds API documentation from source comments and serves it with a local documentation server.


Source: https://findsoftware.frbit.cloud/yard/
Last reviewed: 2026-10-23
Updated: 2026-10-25
Listed since: 2026-10-23

## Record

### Links

- home: https://yardoc.org/
- repository: https://github.com/lsegal/yard
- docs: https://github.com/lsegal/yard/blob/main/README.md
- forum: https://groups.google.com/group/yardoc

### Identity

- status: active
- maintainer: Loren Segal
- maintainerType: individual
- parent: unknown
- firstRelease: 2009
- hqCountry: unknown

### Kind

- category: ssg
- hosting: unknown
- language: ruby
- runtime: ruby
- runtimeMin: ruby 1.8
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: local
- renderingModes: unknown
- installMethod: gem install

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 0
- latestReleaseDate: 2026-07-14

### Adoption

- githubStargazers: 2011
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 176
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 56136
- dependentPackages: 7681

### Sources

- urls: https://api.github.com/repos/lsegal/yard (read 2026-10-23)
- urls: https://yardoc.org/ (read 2026-10-23)
- urls: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- maintainer: https://raw.githubusercontent.com/lsegal/yard/main/LICENSE (read 2026-10-23)
- language: https://api.github.com/repos/lsegal/yard (read 2026-10-23)
- category: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- runtime: https://rubygems.org/api/v1/gems/yard.json (read 2026-10-23)
- installMethod: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- runtimeMin: https://rubygems.org/api/v1/versions/yard.json (read 2026-10-23)
- runsAs: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- license: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- licenseModel: https://github.com/lsegal/yard/blob/main/README.md (read 2026-10-23)
- firstRelease: https://rubygems.org/api/v1/versions/yard.json (read 2026-10-23)
- currentMajor: https://api.github.com/repos/lsegal/yard/releases/latest (read 2026-10-23)
- latestReleaseDate: https://api.github.com/repos/lsegal/yard/releases/latest (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/lsegal/yard (read 2026-10-23)
- contributors: https://api.github.com/repos/lsegal/yard/contributors (read 2026-10-23)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/rubygems.org/packages/yard (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/rubygems.org/packages/yard (read 2026-10-25)

## Notes

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](https://github.com/lsegal/yard/blob/main/README.md) describes the server as a preview for a project under development. It does not describe publishing the generated output.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0