{"meta":{"name":"FindSoftware","page":"https://findsoftware.frbit.cloud/yard/","markdown":"https://findsoftware.frbit.cloud/yard.md","license":"https://creativecommons.org/licenses/by/4.0/","attribution":"FindSoftware, CC BY 4.0","note":"Attributes are recorded, never scored. An absent field means unknown, never zero and never bad."},"record":{"id":"yard","name":"YARD","urls":{"home":"https://yardoc.org/","repository":"https://github.com/lsegal/yard","docs":"https://github.com/lsegal/yard/blob/main/README.md"},"category":["ssg"],"description":"Ruby documentation generation tool that builds API documentation from source comments and serves it with a local documentation server.","maintainer":"Loren Segal","maintainerType":"individual","firstRelease":2009,"language":"ruby","runtime":["ruby"],"runtimeMin":"ruby 1.8","runsAs":["local"],"installMethod":"gem install","licenseModel":"open-source","license":"MIT","currentMajor":"0","latestReleaseDate":"2026-07-14T00:00:00.000Z","githubStargazers":2011,"contributors":176,"packagistDownloads":null,"npmWeeklyDownloads":null,"dependentRepos":56136,"dependentPackages":7681,"social":{"forum":"https://groups.google.com/group/yardoc"},"checkedAt":"2026-10-23T00:00:00.000Z","addedAt":"2026-10-23T00:00:00.000Z","sources":[{"field":"urls","url":"https://api.github.com/repos/lsegal/yard","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"urls","url":"https://yardoc.org/","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"urls","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"maintainer","url":"https://raw.githubusercontent.com/lsegal/yard/main/LICENSE","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"language","url":"https://api.github.com/repos/lsegal/yard","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"category","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"runtime","url":"https://rubygems.org/api/v1/gems/yard.json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"installMethod","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"runtimeMin","url":"https://rubygems.org/api/v1/versions/yard.json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"runsAs","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"license","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"licenseModel","url":"https://github.com/lsegal/yard/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"firstRelease","url":"https://rubygems.org/api/v1/versions/yard.json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"currentMajor","url":"https://api.github.com/repos/lsegal/yard/releases/latest","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"latestReleaseDate","url":"https://api.github.com/repos/lsegal/yard/releases/latest","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"githubStargazers","url":"https://api.github.com/repos/lsegal/yard","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"contributors","url":"https://api.github.com/repos/lsegal/yard/contributors","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"dependentRepos","url":"https://packages.ecosyste.ms/api/v1/registries/rubygems.org/packages/yard","checkedAt":"2026-10-25T00:00:00.000Z"},{"field":"dependentPackages","url":"https://packages.ecosyste.ms/api/v1/registries/rubygems.org/packages/yard","checkedAt":"2026-10-25T00:00:00.000Z"}],"status":"active","ai":"authored"},"prose":"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.\n\n## Worth knowing\n\nThe [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."}