Package Exports

typedoc
typedoc/bin/typedoc
typedoc/dist
typedoc/dist/lib/converter
typedoc/dist/lib/converter/converter
typedoc/dist/lib/models
typedoc/dist/lib/models/comments
typedoc/dist/lib/models/index
typedoc/dist/lib/models/reflections
typedoc/dist/lib/models/reflections/abstract
typedoc/dist/lib/models/reflections/index
typedoc/dist/lib/models/reflections/reference
typedoc/dist/lib/models/types
typedoc/dist/lib/ts-internal
typedoc/dist/lib/utils
typedoc/dist/lib/utils/loggers
typedoc/dist/lib/utils/options
typedoc/dist/lib/utils/options/declaration
typedoc/dist/lib/utils/options/help
typedoc/dist/lib/utils/options/options
typedoc/dist/lib/utils/options/sources
typedoc/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typedoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TypeDoc

Documentation generator for TypeScript projects.

Documentation

Visit our website for more complete documentation and example API documentation:
https://typedoc.org.

There you can find an installation guide explaining how to use typedoc from the cli, webpack, grunt, or gulp. There are additional guides explaining how to extend typedoc using plugins and themes.

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 run with npx.

$ npx typedoc path/to/entry.ts

Usage

To run TypeDoc, pass it your library's entry point. TypeDoc will use the TypeScript compiler to determine what has been exported and document those items. If you specify a directory as an entry point, TypeDoc will treat all files and folders within that directory as entry points.

TypeDoc will try to discover your tsconfig.json file, but if it fails, you can specify the path to it with --tsconfig.

$ typedoc --tsconfig path/to/tsconfig.json path/to/entry.ts

Common Arguments

For a complete list of the command line arguments run typedoc --help or visit our website.

--html <path/to/documentation/>
Specifies the location the documentation should be written to. Defaults to ./docs
--theme <default|minimal|path/to/theme>
Specify the path to the theme that should be used.
--json <path/to/output.json>
Specifies the location and file name a json file describing the project is written to.

Contributing

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:
https://github.com/TypeStrong/typedoc

For more information, read the contribution guide.

typedoc