TypeDoc TypeDoc Example API GitHub Preparing search index... TypeDoc TypeDoc converts comments in TypeScript's source code into HTML documentation or a JSON model. Quick Start TypeDoc generates documentation based on your exports. It will follow re-exports to document members declared in other files for each entry point. # Install npm install --save-dev typedoc # Build docs using package.json "exports" or "main" fields as entry points npx typedoc Copy If TypeDoc is unable to discover your entry points, they can be provided manually: # Build docs using exports from src/index.ts npx typedoc src/index.ts Copy If you are documenting an application rather than a library, which doesn't have a single entry point, you may want to document each file individually. # Generate docs for all TypeScript files under src npx typedoc --entryPointStrategy Expand src Copy TypeDoc supports a variety of options and themes . It is extensible via the plugin API . Settings Theme OS Light Dark On This Page Quick Start Example API GitHub TypeDoc * Loading... Generated using TypeDoc