TypeDoc vs YARD
TypeDoc
typedoc.orgYARD
yardoc.orgSide by side
| Figure | TypeDoc | YARD |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Linux | Yes | Yes |
| API | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.0 (#10) | 7.1 (#29) |
| Extensibility | TypeDoc is extensible through a plugin API, and plugins can add features such as Markdown output. | Developers can extend YARD with plugins to handle custom Ruby syntax and constructs. |
| Installation | TypeDoc runs on Node.js and is available as an npm package. | The site instructs users to install YARD with the RubyGems command gem install yard. |
| Integrations | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. | The site names plugins supporting RSpec, DataMapper, and Sinatra. |
| License | The TypeDoc repository identifies its license as Apache-2.0. | The site states that YARD uses the MIT License. |
| Purpose | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. | YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats. |
| Support | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. | The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch. |
Plans
In their own words
TypeDoc
TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.