Documentation generator for TypeScript projects.
For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.
TypeDoc runs on Node.js and is available as a NPM package.
npm install typedoc --save-dev
To generate documentation TypeDoc needs to know your project entry point, and TypeScript
compiler options. It will automatically try to find your
tsconfig.json file, so you can
just specify the entry point of your library:
If you have multiple entry points, specify each of them. If you specify a directory, TypeDoc will treat each file contained within it as an entry point.
typedoc package1/index.ts package2/index.ts
If your codebase is comprised of one or more npm packages, you can pass the paths to these
packages and TypeDoc will attempt to determine entry points based on
property (with default value
index.js) and if it wasn't found, based on
If any of the packages given are the root of an npm Workspace
or a Yarn Workspace TypeDoc will find all
workspaces defined in the
This mode requires sourcemaps in your JS entry points, in order to find the TS entry points.
Supports wildcard paths in the same fashion as those found in npm or Yarn workspaces.
typedoc --packages .
typedoc --packages .
This can be useful if you do not want all your workspaces to be processed.
Accepts the same paths as would go in the
# Note the single quotes prevent shell wildcard expansion, allowing typedoc to do the expansion typedoc --packages a-package --packages 'some-more-packages/*' --packages 'some-other-packages/*'
For a complete list of the command line arguments run
typedoc --help or visit
--name <Documentation title>
noneto disable the index page and start the documentation on the globals page.
This project is maintained by a community of developers. Contributions are welcome and appreciated. You can find TypeDoc on GitHub; feel free to open an issue or create a pull request: https://github.com/TypeStrong/typedoc
For more information, read the contribution guide.