Documentation generator for TypeScript projects.
TypeDoc runs on Node.js and is available as an NPM package. You can install TypeDoc in your project's directory as usual:
$ npm install typedoc --save-dev
Like the TypeScript compiler, TypeDoc comes with a binary that can be called from anywhere
if you install TypeDoc as a global module. The name of the executable is
$ npm install typedoc --global $ typedoc
TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. One major difference is the fact that one may pass an entire directory instead of individual files to the documentation generator. So in order to create a documentation for an entire project you simply type:
$ typedoc --out path/to/documentation/ path/to/typescript/project/
Starting with version 0.2, TypeDoc no longer can predict whether files should be treated as modules
or whether the project should be compiled into one big namespace. You must specify the
in order to change the behaviour of TypeDoc.
For a complete list of the command line arguments run
typedoc --help or read here.
--module <commonjs, amd, system or umd>
--target <ES3, ES5, or ES6>
--name <Documentation title>
noneto disable the index page and start the documentation on the globals page.
Specifies the location to look for included documents. One may use
in comments to include documents from this location.
Specifies the location with media files that should be copied to the output directory. In order to create a link to media files use the pattern
media://FILENAME in comments.
There is a plugin available to run TypeDoc with Webpack created by Microsoft. You can find it on NPM:
There is a plugin available to run TypeDoc with Gulp created by Rogier Schouten. You can find it on NPM:
There is a plugin available to run TypeDoc with Grunt created by Bart van der Schoor. You can find it on NPM:
@tagsas single lines
A list of all published Typedoc plugins can be found on NPM:
Visit our homepage for advanced guides and an extensive API documentation:
This project is maintained by a community of developers. Contributions are welcome and appreciated.
You can find TypeDoc on GitHub; feel free to start an issue or create a pull requests:
For more information, read the contribution guide.