Download
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. TypeDoc requires Node.js to be installed on your system. Installing TypeDoc is available as a node package. Using npm ensures that all relevant dependencies are setup correctly. You can choose to either install locally to your project or globally to the CLI. TypeDoc aims to support the two latest TypeScript releases for the latest release. Depending on the scale of breaking changes introduced in a new TypeScript version, a given version may support more versions of TypeScript. The CLI can be used both from your terminal or from npm scripts. All arguments that are not passed with flags are parsed as entry points. Use either the --out or --json arguments to define the format and destination of your documentation.
Features
- Built-in support for various TypeScript language constructs
- Markdown in doc comments
- Syntax highligting in code blocks
- TypeDoc automatically documents every variable exported by your project
- You can add explanations and examples to your documentation site
- Annotate your code with doc comments
Project Samples
