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

See the API tab for TypeDoc's API documentation, rendered with TypeDoc.

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

# Install
npm install typedoc

# Execute typedoc on your project
npx typedoc src/index.ts

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