Repository files navigation

Documentation generator for TypeScript projects.

For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, seehttps://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 TypeScriptcompiler options. It will automatically try to find yourtsconfig.json file, so you canjust specify the entry point of your library:

typedoc src/index.ts

If you have multiple entry points, specify each of them.

typedoc package1/index.ts package2/index.ts

If you specify a directory, TypeDoc will use theentryPointStrategy option to determine how to resolve it.By default, TypeDoc will search for a file calledindex under the directory.

If your codebase is comprised of one or more npm packages, you can build documentation for each of them individuallyand merge the results together into a single site by settingentryPointStrategy topackages. In this mode TypeDocrequires configuration to be present in each directory to specify the entry points. For an example setup, seehttps://github.com/Gerrit0/typedoc-packages-example

For a complete list of the command line arguments runtypedoc --help or visitour website.

• --out <path/to/documentation/>
  Specifies the location the documentation should be written to. Defaults to./docs
• --json <path/to/output.json>
  Specifies the location and file name a json file describing the project iswritten to. When specified no documentation will be generated unless--out is alsospecified.
• --options
  Specify a json option file that should be loaded. If not specified TypeDocwill look for 'typedoc.json' in the current directory.
• --tsconfig <path/to/tsconfig.json>
  Specify a typescript config file that should be loaded. If notspecified TypeDoc will look for 'tsconfig.json' in the current directory.
• --exclude <pattern>
  Exclude files by the given pattern when a path is provided as source.Supports standard minimatch patterns.

• --theme <default|plugin defined theme>
  Specify 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. Passnone to disable the index pageand start the documentation on the globals page.

• --version
  Display the version number of TypeDoc.
• --help
  Display all TypeDoc options.

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 thecontribution guide.