TypeDoc is a documentation generator for TypeScript projects.
TypeDoc solves the problem of automatically generating API documentation from TypeScript source code. It works by analyzing your TypeScript project, reading compiler options from tsconfig.json and entry points from package.json, then generating HTML documentation or JSON output describing your project's public API. The tool requires minimal configuration to get started, automatically discovering project structure in most cases, though you can manually specify entry points and customize behavior through command-line arguments or configuration files.
TypeDoc suits any TypeScript project that needs to maintain API documentation alongside code. It handles monorepos and workspaces by supporting a packages entry point strategy, allowing you to build documentation for multiple npm packages and merge them into a single site. The tool offers theming options to customize the appearance of generated documentation, and can output either HTML for human readers or JSON for programmatic consumption. Projects that want documentation to stay synchronized with code changes benefit from TypeDoc's ability to regenerate from source on demand.
The project maintains active community engagement with a contribution guide and open invitation for pull requests and issues. Development shows consistent attention to configuration flexibility, with support for both command-line arguments and configuration files, and regular refinement of options for controlling output location, theming, and TypeScript compiler integration.
