Skip to content
SPECIFICTION
Get listed

TypeDoc

typedoc.org

Free plan LinuxAPISelf-hosted
Visit typedoc.org
Spec score 8.0 #10 of 37 in Documentation Generators

What it is

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.

Spec sheet

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

Plans and prices

Free and open source Free Documentation generator for TypeScript projects · Apache-2.0 license Read 9 Oct 2026 · github.com

Every TypeDoc plan and price →

Strong points and limits

Strong points

  • Generates HTML and JSON output
  • Follows exports and re-exports
  • Supports TSDoc, JSDoc, and Markdown
  • Plugin and theme extensibility
  • Monorepo package strategy

Limits

  • Markdown output requires a plugin
  • Requires Node.js
  • Global installation can break plugins and themes
  • TypeScript support is version-specific

Who it suits

It suits TypeScript projects that need generated HTML or JSON reference documentation, including npm monorepos. Teams wanting Markdown output or custom behavior should expect to use plugins.

Verdict

TypeDoc provides configurable, export-aware documentation generation for TypeScript codebases. Its built-in formats cover common needs, while Markdown and deeper presentation changes depend on plugins.

Where Specifiction places it

Alternatives to TypeDocAll alternatives →