Skip to content
aicoolies logo
TypeDoc logo

TypeDoc

Documentation generator for TypeScript

Documentation generator that converts TypeScript source comments into HTML, JSON, or Markdown reference sites. TypeDoc reads JSDoc-style annotations directly from .ts files, using the TypeScript compiler API to extract types, signatures, classes, and modules without duplicating annotations. Themes and plugins customize output for libraries, monorepos, and design systems. De facto standard for documenting open-source TypeScript packages — used by Pixi.js, NestJS, and thousands more.

About TypeDoc

TypeDoc is the canonical documentation generator for TypeScript projects. Created by Sebastian Lenz, it has become the default tool for producing API reference sites for open-source TypeScript libraries, internal SDKs, and design system component libraries. Unlike documentation tools that require separate annotation languages, TypeDoc reads ordinary JSDoc-style comments directly from .ts source files and uses the TypeScript compiler API to resolve types — meaning function signatures, generics, interfaces, and exported symbols are extracted from the source of truth rather than duplicated by hand.

Out of the box, TypeDoc produces a static HTML site with a sidebar tree of modules, classes, functions, and enums; deep links into each declaration; cross-references between related types; and configurable navigation. Built-in themes (default, light, and dark) can be replaced by community themes — typedoc-material-theme and typedoc-theme-hierarchy are popular — or extended with custom render hooks and plugins. Output formats include HTML, JSON (for downstream pipelines), and Markdown via plugins, making it straightforward to publish on GitHub Pages, Vercel, or alongside a Docusaurus or VitePress handbook.

TypeDoc is MIT licensed and free, with no hosted service or paid tier — it runs as a CLI in CI pipelines, typically wired into pre-publish or post-build steps. Configuration lives in tsconfig.json or a typedoc.json file; common options handle entry points, monorepo packages, exclude patterns, and JSDoc tag handling. For TypeScript library authors who want reference docs that stay in sync with their actual exported types — without writing a separate documentation file for every function — TypeDoc remains the standard choice in 2026.

Pricing & Platform Specs

Pricing Summary

Free and open-source TypeScript documentation generator under the Apache License 2.0 ($0). Provides automatic static API documentation generation from TypeScript source code and TSDoc/JSDoc annotations. Fully free for commercial and non-commercial use with no paid tiers, enterprise upsells, or usage restrictions.

full pricing breakdown →

Supported Platforms

Node.js

Explore categories, tags & use cases

Beautiful documentation that converts

AI-powered documentation platform that transforms markdown into beautiful, searchable docs sites with minimal config. Features AI writing suggestions, auto API reference generation from OpenAPI specs, built-in analytics, versioning, custom domains, and a web editor for non-technical contributors. Supports MDX for interactive components. GitHub integration for CI/CD updates. Used by Anthropic, Cursor, Turso, and hundreds of developer-focused companies.

freemium

Build optimized documentation sites

Meta's open-source documentation framework built on React with MDX support, versioning, internationalization, and search. Powers documentation sites for many open-source projects with 58k+ GitHub stars. The standard choice for open-source projects that need professional documentation with minimal setup, offering blog support and plugin extensibility alongside core docs features.

Open Source

Vite & Vue powered static site generator

Static site generator built on Vite and Vue.js for fast documentation sites. Write in Markdown with embedded Vue components. Automatic sidebar from file structure, full-text search, dark mode, i18n, code group tabs, and customizable themes with Tailwind CSS. Minimal JavaScript for near-instant page loads. Created by Evan You (Vue/Vite creator). Powers Vue, Vite, and Pinia docs. The standard docs tool for Vue ecosystem projects.

Open Source

Community experience

Sources & verification

Sources checked
Content verified

Verification dates are editorial checks. Routine CMS saves and automatic updatedAt timestamps do not advance them.

FAQ

What is TypeDoc?

Documentation generator that converts TypeScript source comments into HTML, JSON, or Markdown reference sites. TypeDoc reads JSDoc-style annotations directly from .ts files, using the TypeScript compiler API to extract types, signatures, classes, and modules without duplicating annotations. Themes and plugins customize output for libraries, monorepos, and design systems. De facto standard for documenting open-source TypeScript packages — used by Pixi.js, NestJS, and thousands more.

Is TypeDoc free?

Yes — TypeDoc is open source and free to use. Free and open-source TypeScript documentation generator under the Apache License 2.0 ($0). Provides automatic static API documentation generation from TypeScript source code and TSDoc/JSDoc annotations. Fully free for commercial and non-commercial use with no paid tiers, enterprise upsells, or usage restrictions.

Is TypeDoc open source?

Yes — TypeDoc is open source.

Is TypeDoc still maintained?

Yes — TypeDoc is active. Its listing was last verified on September 6, 2026.

What are the best TypeDoc alternatives?

The first editor-selected TypeDoc alternatives are Mintlify, Docusaurus, VitePress.