About TypeDoc
TypeDoc is a documentation generator for TypeScript projects. It reads the comments in your code and produces a readable reference website or structured data that other tools can use.
What it does
TypeDoc follows the exports of your package from its entry points, including re-exports declared in other files, and builds HTML pages from the doc comments it finds. It can also write a JSON model of the API. Behavior is set through options and themes, and a plugin API lets you extend it when the defaults are not enough.
Key features
- Entry points read from package.json or set by hand
- Documents each file when you have an application
- HTML themes and a JSON output option
- Plugin API for custom behavior
- Extra external documents can be added to the site
Who it's for
TypeScript library authors and teams that want an API reference generated from their code. It is also useful for application codebases, where you can document every file under a source folder.
Pricing and good to know
The repository is listed under the Apache-2.0 license, so the tool is free to use under those terms. It is installed through npm and runs in a Node.js environment, and it writes static files that you can host on any web server. Entry points usually need to be set in your package configuration so that the output matches your public API.
Highlights
- Builds HTML docs from TypeScript doc comments
- Writes a JSON model of the API
- Follows re-exports across files
- Supports themes and custom plugins
- Documents a whole source folder when needed
