rustdoc vs TypeDoc
rustdoc
doc.rust-lang.orgTypeDoc
typedoc.orgSide by side
| Figure | rustdoc | TypeDoc |
|---|---|---|
| Price from | — | Free |
| Free plan | — | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| API | — | Yes |
| Self-hosted | — | Yes |
| Plans published | 0 | 1 |
| Spec score · Documentation Generators | 7.4 (#23) | 8.0 (#10) |
| Installation | Rust's installation page recommends rustup and provides installation instructions for Windows, macOS, Linux, and other Unix-like systems. | TypeDoc runs on Node.js and is available as an npm package. |
| Purpose | rustdoc generates documentation for Rust projects from a crate root or Markdown file, producing HTML, CSS, and JavaScript. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The Rust site directs users to the documentation, Rust Forge contributor documentation, and the Users Forum for help. | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. |
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.