TypeDoc

Free plan APILinuxSelf-hosted

What TypeDoc is

TypeDoc is a free documentation generator that turns comments in TypeScript source code into HTML documentation or a JSON model. It builds its output from project exports and follows re-exports, including members declared in other files. It extracts TSDoc and JSDoc tags, supports Markdown in comments, and highlights fenced code blocks using Shiki. HTML and JSON output are built in; Markdown output can be added with a plugin such as typedoc-plugin-markdown.

The tool runs on Node.js, is available as an npm package and uses the TypeScript compiler to parse code. It includes a default theme, and themes can be added through plugins; custom CSS or JavaScript can also alter the generated pages. Plugins can modify conversion, symbol organization and display, and are loaded with the --plugin flag. Configuration can be read from an options file, package.json or tsconfig.json. For npm monorepos, TypeDoc can generate documentation for each package and combine results into one site using the packages entry-point strategy. The project identifies its license as Apache-2.0. TypeDoc supports the current Node.js LTS version or newer, and TypeDoc 0.28 is maintained for TypeScript versions 5.0 through 5.8.

Who it suits

TypeDoc suits TypeScript developers who want to generate reference documentation from source comments and project exports. It also fits npm monorepos whose teams want package documentation combined into one site, and users who can extend output through plugins.

What it does well

Generates HTML and JSON documentation from TypeScript comments.
Follows re-exports when documenting project members.
Supports TSDoc, JSDoc, Markdown comments and syntax highlighting.
Plugins can add themes and alter conversion or display.
Can combine npm monorepo package documentation into one site.

What to know first

Markdown output requires a plugin.
Global installation can cause plugins or themes to use a separate TypeDoc installation and break.
The tool requires Node.js.

Limits

HTML and JSON are built-in output types; Markdown output requires a plugin. The documentation warns that global installation can cause plugins and themes to use a separate TypeDoc installation and break.

Plans

Plan	Billed and limits	Price
Free and open source	Documentation generator for TypeScript projects · Apache-2.0 license	Free

As typedoc.org lists them, read 9 Oct 2026. The maker's own page has the final word.

Getting started

Install TypeDoc from npm.
Use Node.js at the current LTS version or newer.
Configure options in an options file, package.json or tsconfig.json.
Generate documentation from project exports.
For Markdown output, add a plugin such as typedoc-plugin-markdown.

Verdict

Choose TypeDoc if you need free generation of TypeScript documentation from code comments, with built-in HTML and JSON output and a plugin API. Look elsewhere if Markdown output without a plugin is essential. Avoid a global installation when plugins or themes need to work with the same TypeDoc installation.

Questions

Does TypeDoc cost anything?

TypeDoc is free and open source under the Apache-2.0 license.

What output formats does it provide?

HTML and JSON are built in. Markdown output requires a plugin such as typedoc-plugin-markdown.

What runtime does TypeDoc need?

It runs on Node.js and supports the current LTS version or newer.

Can TypeDoc document npm monorepos?

Yes. It can build documentation for each package and merge the results into one site using the packages entry-point strategy.

Can its output be customized?

Yes. TypeDoc includes a default theme, supports themes through plugins, and allows custom CSS or JavaScript.

How can users get project support?

The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide.

Facts from TypeDoc's own pages

Code highlighting: TypeDoc supports fenced code blocks and uses Shiki for syntax highlighting. · typedoc.org, 9 Oct 2026
Comment formats: TypeDoc extracts TSDoc/JSDoc tags and supports Markdown in comments. · typedoc.org, 9 Oct 2026
Configuration: Options can be set through command-line arguments or configuration files. · typedoc.org, 9 Oct 2026
Customization: Themes can change the look and feel of generated documentation, and plugins can add themes. · typedoc.org, 9 Oct 2026
Entry points: TypeDoc can infer entry points from package.json or accept entry points specified manually. · github.com, 9 Oct 2026
Exports: It generates documentation based on project exports and follows re-exports to document members declared in other files. · typedoc.org, 9 Oct 2026
Extensibility: TypeDoc is extensible through a plugin API, and plugins can add features such as Markdown output. · typedoc.org, 9 Oct 2026
Installation: TypeDoc runs on Node.js and is available as an npm package. · github.com, 9 Oct 2026
Integrations: The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. · typedoc.org, 9 Oct 2026
License: The TypeDoc repository identifies its license as Apache-2.0. · github.com, 9 Oct 2026
License and security: The GitHub repository identifies the project as Apache-2.0 licensed and links to a security policy. · github.com, 9 Oct 2026
Monorepos: For npm package codebases, TypeDoc can build documentation for each package and merge results into a single site using entryPointStrategy set to packages. · github.com, 9 Oct 2026
Notable limitation: The documentation warns that global installation can cause plugins and themes to use a separate TypeDoc installation and break. · typedoc.org, 9 Oct 2026
Output formats: HTML and JSON are built-in output types; Markdown output requires a plugin such as typedoc-plugin-markdown. · typedoc.org, 9 Oct 2026
Plugin support: Plugins can modify project conversion, symbol organization, and display, and are loaded with the --plugin flag. · typedoc.org, 9 Oct 2026
Purpose: TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. · typedoc.org, 9 Oct 2026
Runtime: TypeDoc requires Node.js and supports the current LTS version or newer. · typedoc.org, 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. · github.com, 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. · github.com, 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. · github.com, 9 Oct 2026
Theming: TypeDoc includes a default theme, supports themes added by plugins, and allows custom CSS or JavaScript. · typedoc.org, 9 Oct 2026
TypeScript compatibility: The documentation lists TypeDoc 0.28 as maintained for TypeScript versions 5.0 through 5.8. · typedoc.org, 9 Oct 2026
TypeScript compiler: TypeDoc parses code using the TypeScript compiler and behaves similarly to tsc. · typedoc.org, 9 Oct 2026