TypeDoc
TypeDoc is a free documentation generator for TypeScript projects.
What TypeDoc is
TypeDoc is a free documentation generator for TypeScript projects. It reads comments in source code and turns them into HTML documentation or a JSON model, building from project exports and following re-exports to include members declared in other files. It extracts TSDoc and JSDoc tags, accepts Markdown in comments, and highlights fenced code blocks with Shiki. HTML and JSON are built in; Markdown output requires a plugin such as typedoc-plugin-markdown. TypeDoc includes a default theme, and themes, CSS, or JavaScript can change the generated pages. Plugins can also alter conversion, symbol organization, and display, and are loaded with the --plugin flag. Configuration can come from an options file, package.json, or tsconfig.json. For npm monorepos, a package entry-point strategy can combine documentation into one site. TypeDoc runs on Node.js and parses code using the TypeScript compiler. It supports current Node.js LTS or newer; TypeDoc 0.28 is maintained for TypeScript 5.0 through 5.8. The project is Apache-2.0 licensed. Global installation can cause plugins and themes to use a separate TypeDoc installation and break.
Good
- Generates HTML and JSON from TypeScript comments
- Follows re-exports from project entry points
- Includes a default theme and plugin API
- Supports package-based monorepo documentation
Watch out
- Markdown output requires a plugin
- Requires Node.js current LTS or newer
- Global installation can break plugins and themes
Who it suits
TypeDoc suits TypeScript developers who want to generate documentation from code comments and project exports. Its plugins and monorepo support may also suit projects that need customized output or combined package documentation.
Verdict
TypeDoc provides a free way to produce HTML or JSON documentation from TypeScript projects, with options to customize output and extend it through plugins. Markdown output takes an additional plugin, and global installation carries a documented risk for plugins and themes.
Plans and prices
From TypeDoc's own pricing page, checked 9 Oct 2026.
| Plan | Price | What it gives you |
|---|---|---|
| Free and open source | Free | Documentation generator for TypeScript projects · Apache-2.0 license |
The facts
Each one read from TypeDoc's own pages, with the date it was checked.
What it does
- Code highlighting
- TypeDoc supports fenced code blocks and uses Shiki for syntax highlighting.checked 9 Oct 2026
- Comment formats
- TypeDoc extracts TSDoc/JSDoc tags and supports Markdown in comments.checked 9 Oct 2026
- Configuration
- Options can be set through command-line arguments or configuration files.checked 9 Oct 2026
- Customization
- Themes can change the look and feel of generated documentation, and plugins can add themes.checked 9 Oct 2026
- Entry points
- TypeDoc can infer entry points from package.json or accept entry points specified manually.checked 9 Oct 2026
- Exports
- It generates documentation based on project exports and follows re-exports to document members declared in other files.checked 9 Oct 2026
- Extensibility
- TypeDoc is extensible through a plugin API, and plugins can add features such as Markdown output.checked 9 Oct 2026
- Installation
- TypeDoc runs on Node.js and is available as an npm package.checked 9 Oct 2026
- Integrations
- The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes.checked 9 Oct 2026
- License
- The TypeDoc repository identifies its license as Apache-2.0.checked 9 Oct 2026
- License and security
- The GitHub repository identifies the project as Apache-2.0 licensed and links to a security policy.checked 9 Oct 2026
- Notable limitation
- The documentation warns that global installation can cause plugins and themes to use a separate TypeDoc installation and break.checked 9 Oct 2026
- Output formats
- HTML and JSON are built-in output types; Markdown output requires a plugin such as typedoc-plugin-markdown.checked 9 Oct 2026
- Plugin support
- Plugins can modify project conversion, symbol organization, and display, and are loaded with the --plugin flag.checked 9 Oct 2026
- Purpose
- TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model.checked 9 Oct 2026
- Runtime
- TypeDoc requires Node.js and supports the current LTS version or newer.checked 9 Oct 2026
- Security
- The GitHub repository links to a security policy, but the opened repository page does not state specific security certifications or compliance claims.checked 9 Oct 2026
- Support
- The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide.checked 9 Oct 2026
- Support and maintenance
- The project is maintained by a community of developers, and its repository invites users to open issues or pull requests.checked 9 Oct 2026
- Theming
- TypeDoc includes a default theme, supports themes added by plugins, and allows custom CSS or JavaScript.checked 9 Oct 2026
- TypeScript compatibility
- The documentation lists TypeDoc 0.28 as maintained for TypeScript versions 5.0 through 5.8.checked 9 Oct 2026
- TypeScript compiler
- TypeDoc parses code using the TypeScript compiler and behaves similarly to tsc.checked 9 Oct 2026
Where it runs
- Monorepos
- For npm package codebases, TypeDoc can build documentation for each package and merge results into a single site using entryPointStrategy set to packages.checked 9 Oct 2026
Alternatives to TypeDoc
- 1
Scalar
Free planOpen sourceWebAPILinuxmacOS8.4From $150 a month - 2
Redocly
WebAPIExtension7.0From $10 a month - 3
Sphinx
Free planWebAPILinuxmacOS7.0Free plan - 4
Asciidoctor
Free planWebAPIExtensionLinux6.9Free plan - 5
JSON Schema for Humans
Free planLinuxmacOSSelf-hostedWindows6.5Free plan - 6
StepShot
Free planmacOS6.5CN¥269 one-time