TypeDoc

Overview

TypeDoc is an open-source documentation generator for TypeScript projects. It parses comments in TypeScript source code and converts them into HTML documentation or a JSON model. It supports various options and themes, and it is extensible via a plugin API. TypeDoc can generate documentation based on exports, following re-exports to document members declared in other files. It can handle single entry points or document each file individually, making it suitable for both libraries and applications. It supports linking references to types, including those declared in external packages via plugins.

Common tasks

Documentation Generation API Reference Creation

FAQ

View all

How do I install TypeDoc?

You can install TypeDoc using npm: npm install --save-dev typedoc.

How do I configure TypeDoc?

You can configure TypeDoc using a typedoc.json file in your project's root directory. This file allows you to specify options such as entry points, theme, and plugins.

How do I generate documentation with TypeDoc?

You can generate documentation by running the command npx typedoc in your project's root directory. This will generate HTML documentation based on your TypeScript code and comments.

How do I add plugins to TypeDoc?

You can add plugins to TypeDoc using the --plugin flag when running the typedoc command. For example: npx typedoc --plugin typedoc-plugin-markdown.

FAQ+