Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

TypeDoc

typedoc.org

  • Free plan
  • Linux
  • API
  • Self-hosted
7.4 Club score Visit typedoc.org

What TypeDoc is

TypeDoc is a free, open-source documentation generator for TypeScript projects. It reads project exports and converts source comments into HTML documentation or a JSON model, following re-exports so members from other files can appear. TSDoc and JSDoc tags are extracted, Markdown is supported in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output requires a plugin such as typedoc-plugin-markdown. TypeDoc includes a default theme, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript are supported. Configuration can come from an options file, package.json or tsconfig.json. It runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. Npm monorepos can combine package documentation through the packages entry-point strategy. The project identifies its license as Apache-2.0.

Who it suits

TypeDoc suits TypeScript developers who need generated API documentation from source comments. It also fits npm monorepos and self-hosted documentation workflows that can use Node.js and plugins.

Good to know, and what to watch

  • Generates HTML and JSON documentation outputs
  • Follows exports and re-exports across files
  • Supports TSDoc, JSDoc and Markdown comments
  • Plugins extend themes, conversion and display
  • Monorepos can merge package documentation
  • Markdown output requires a plugin
  • Global installation can break plugin and theme usage
  • Requires Node.js and a maintained TypeScript version
  • No hosted service is listed

Free and open source

Free

Free plan

The verdict

TypeDoc provides a configurable, source-driven way to publish TypeScript documentation. Its plugin model and monorepo support add flexibility, but Markdown output and installation choices require attention.

What the maker publishes

Code highlighting
TypeDoc supports fenced code blocks and uses Shiki for syntax highlighting. source
Comment formats
TypeDoc extracts TSDoc/JSDoc tags and supports Markdown in comments. source
Configuration
TypeDoc reads options from an options file, package.json, or tsconfig.json. source
Configuration
Options can be set through command-line arguments or configuration files. source
Customization
Themes can change the look and feel of generated documentation, and plugins can add themes. source
Entry points
TypeDoc generates documentation based on project exports and follows re-exports for each entry point. source
Entry points
TypeDoc can infer entry points from package.json or accept entry points specified manually. source
Exports
It generates documentation based on project exports and follows re-exports to document members declared in other files. source
Extensibility
TypeDoc is extensible through a plugin API, and plugins can add features such as Markdown output. source
Installation
TypeDoc runs on Node.js and is available as an npm package. source
Integrations
The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. source
License
The TypeDoc repository identifies its license as Apache-2.0. source
License and security
The GitHub repository identifies the project as Apache-2.0 licensed and links to a security policy. source
Monorepos
For npm package codebases, TypeDoc can build documentation for each package and merge results into a single site using entryPointStrategy set to packages. source
Notable limitation
The documentation warns that global installation can cause plugins and themes to use a separate TypeDoc installation and break. source
Output formats
HTML and JSON are built-in output types; Markdown output requires a plugin such as typedoc-plugin-markdown. source
Output formats
The default output is HTML, and TypeDoc can also write a JSON model describing the project. source
Plugin support
Plugins can modify project conversion, symbol organization, and display, and are loaded with the --plugin flag. source
Purpose
TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. source
Runtime
TypeDoc requires Node.js and supports the current LTS version or newer. source
Security
The GitHub repository links to a security policy, but the opened repository page does not state specific security certifications or compliance claims. source
Support
The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. source
Support and maintenance
The project is maintained by a community of developers, and its repository invites users to open issues or pull requests. source
Theming
TypeDoc includes a default theme, supports themes added by plugins, and allows custom CSS or JavaScript. source

Checked against the maker's pages on 9 Oct 2026.