TypeDoc generates API documentation from TypeScript source code and documentation comments. It follows a project’s exported symbols to build a browsable reference for libraries and applications.
Projects containing multiple packages can combine their documentation into a single site while retaining individual package configuration.
This is free and open source software.
Key Features
- Generates HTML documentation covering exported classes, interfaces, functions, types, and other declarations.
- Provides searchable output to help readers locate API members across a project.
- Exports a JSON representation of the documentation model for further processing and integration.
- Reads TypeScript compiler settings from tsconfig.json and can discover entry points from package.json.
- Supports explicitly selected entry points for controlling which parts of a codebase are documented.
- Combines documentation from multiple packages in monorepos and workspaces into one website.
- Uses a project’s README as the documentation landing page, with configurable project titles.
- Organizes API members into groups and categories with configurable ordering.
- Filters private, protected, internal, external, or undocumented symbols from generated output.
- Links documented declarations to their source files in a remote repository.
- Supports custom themes, stylesheets, favicons, and syntax highlighting settings.
- Provides a plugin system for extending documentation generation and presentation.
- Accepts configuration files and command-line options for repeatable documentation builds.
- Cross-platform support – runs on Linux and Windows.
Website: github.com/TypeStrong/typedoc
Support:
Developer: TypeDoc contributors
License: Apache License 2.0
TypeDoc is written in TypeScript. Learn TypeScript with our recommended free books and free tutorials.
Related Software
| Documentation Generators | |
|---|---|
| JSDoc | API documentation generator for JavaScript |
| Javadoc | Generate API documentation in HTML format |
| Sphinx | Create intelligent and beautiful documentation for Python projects |
| phpDocumentor | Complete documentation solution for PHP |
| Doxygen | Documentation system for C, C++, Java, Python and other languages |
| Docusaurus | Build, deploy and maintain documentation websites |
| mdBook | Create modern online books from Markdown files |
| YARD | Ruby documentation tool |
| Starlight | Documentation website framework |
| Docco | Literate-programming-style documentation generator |
| Natural Docs | Documentation generator that supports 21 different languages |
| Quarto | Scientific and technical publishing system |
| Antora | Modular documentation site generator |
| Crycco | Quick and dirty documentation generator |
| ROBODoc | Documentation tool similar to Javadoc |
Read our verdict in the software roundup.
 LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README. |
Please read our Comment Policy before commenting.