TypeDoc
Documentation generator for TypeScript projects.
![NPM version](https://badge.fury.io/js/typedoc.svg)
Installation
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 typedoc
.
$ npm install typedoc --global
$ typedoc
Preview
If you want to know what a documentation created with TypeDoc looks like, head over
to the homepage of the project. We've setup examples demonstrating the two default
themes shipped with the package:
http://typedoc.io/themes/default
http://typedoc.io/themes/minimal
Usage
Shell
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/
Important note
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 mode
argument
in order to change the behaviour of TypeDoc.
Arguments
--out <path/to/documentation/>
Specifies the location the documentation should be written to.--mode <file|modules>
Specifies the output mode the project is used to be compiled with.--json <path/to/output.json>
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated.
Source file handling
--exclude <pattern>
Exclude files by the given pattern when a path is provided as source--includeDeclarations
Turn on parsing of .d.ts declaration files.--externalPattern <pattern>
Define a pattern for files that should be considered being external.--excludeExternals
Prevent externally resolved TypeScript files from being documented.
TypeScript compiler
--module <commonjs or amd>
Specify module code generation: "commonjs" or "amd"--target <ES3 or ES5>
Specify ECMAScript target version: "ES3" (default), or "ES5"
Theming
--theme <default|minimal|path/to/theme>
Specify the path to the theme that should be used.--name <Documentation title>
Set the name of the project that will be used in the header of the template.--readme <path/to/readme|none>
Path to the readme file that should be displayed on the index page. Pass none
to disable the index page
and start the documentation on the globals page.--hideGenerator
Do not print the TypeDoc link at the end of the page.--gaID
Set the Google Analytics tracking ID and activate tracking code.--gaSite <site>
Set the site name for Google Analytics. Defaults to auto
Miscellaneous
--version
Display the version number of TypeDoc.--help
Display a simple cheat sheet.--verbose
Print more information while TypeDoc is running.
Gulp
There is a plugin available to run TypeDoc with Gulp created by Rogier Schouten. You can find it on NPM:
https://www.npmjs.org/package/gulp-typedoc/
Grunt
There is a plugin available to run TypeDoc with Grunt created by Bart van der Schoor. You can find it on NPM:
https://www.npmjs.org/package/grunt-typedoc
Advanced guides and docs
Visit our homepage for advanced guides and an extensive API documentation:
http://typedoc.io
Contributing
Contributions are welcome and appreciated. You can find TypeDoc on GitHub, feel free to start
an issue or create a pull requests:
https://github.com/sebastian-lenz/typedoc
License
Copyright (c) 2015 Sebastian Lenz.
Licensed under the Apache License 2.0.