A documentation generator for TypeScript projects.

TypeDoc converts comments in TypeScript source code into rendered HTML documentation or a JSON model. It is extensible and supports a variety of configurations. Available as a CLI or Node module.

Quick Start

If you have npm installed, start using typedoc with the following commands.

# Install the global CLI
npm install --global typedoc

#Execute typedoc on your project
typedoc --out docs /src

For more advanced usage and configuration guides, see the installation guide.