• Stars
    star
    7,258
  • Rank 5,026 (Top 0.2 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created almost 10 years ago
  • Updated 29 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Documentation generator for TypeScript projects.

TypeDoc

Documentation generator for TypeScript projects.

CI NPM Version

Documentation

For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.

Installation

TypeDoc runs on Node.js and is available as a NPM package.

npm install typedoc --save-dev

Usage

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:

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 the entryPointStrategy option to determine how to resolve it. By default, TypeDoc will search for a file called index under the directory.

Monorepos / Workspaces

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

Arguments

For a complete list of the command line arguments run typedoc --help or visit our 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 is written to. When specified no documentation will be generated unless --out is also specified.
  • --options
    Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory.
  • --tsconfig <path/to/tsconfig.json>
    Specify a typescript config file that should be loaded. If not specified 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.

Theming

  • --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. Pass none to disable the index page and start the documentation on the globals page.

Miscellaneous

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

Contributing

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.

More Repositories

1

ts-node

TypeScript execution and REPL for node.js
TypeScript
12,395
star
2

ts-loader

TypeScript loader for webpack
TypeScript
3,413
star
3

fork-ts-checker-webpack-plugin

Webpack plugin that runs typescript type checker on a separate process.
TypeScript
1,910
star
4

atom-typescript

The only TypeScript package you will ever need
TypeScript
1,129
star
5

learn-typescript

The complete workshop for picking up TypeScript
TypeScript
679
star
6

tsify

Browserify plugin for compiling TypeScript
JavaScript
339
star
7

grunt-ts

A grunt task to manage your complete typescript development to production workflow
JavaScript
326
star
8

dts-bundle

Export TypeScript .d.ts files as an external module definition
TypeScript
307
star
9

ts-expect

Checks TypeScript types match expected values
TypeScript
193
star
10

ntypescript

Nicer TypeScript for API devs
JavaScript
115
star
11

tsconfig

Resolve and parse `tsconfig.json`, replicating TypeScript's behaviour
TypeScript
102
star
12

typedoc-default-themes

Handlebars
56
star
13

typedoc-site

Website for TypeDoc
TypeScript
37
star
14

grunt-typedoc

Grunt plugin to generate TypeScript docs with TypeDoc
JavaScript
16
star
15

tspms

An abstraction on top TypeScript language service, that let you consume it in the context of a project.
TypeScript
13
star
16

typedoc-auto-docs

An idea from TS Discord to automatically render docs for the ecosystem, similar to docs.rs and doc.deno.land
TypeScript
9
star
17

typescript-compiler-docs

Community docs about typescript's compiler and APIs
8
star
18

atom-typescript-examples

Temporary location of examples for mutual testing
JavaScript
8
star
19

tscs

TypeScript Compiler Services
JavaScript
7
star
20

grunt-ts-clean

Grunt plugin to cleanup TypeScript builds for release.
JavaScript
6
star
21

typedoc-repros

Shell
5
star
22

csproj2ts

Library to parse TypeScript config info from a Visual Studio Project file
TypeScript
5
star
23

ts-node-repros

Dockerfile
5
star
24

tsproj

A specification for a file format + Parser Implementation for specifying TypeScript projects
TypeScript
5
star
25

grunt-dts-bundle

Grunt plugin to export TypeScript .d.ts files as an external module definition
JavaScript
4
star
26

typestrong.github.io

Website
HTML
4
star
27

fs-fixture-builder

TypeScript
4
star
28

typedoc-action

TypeScript
4
star
29

typestrong-compiler

experimental compiler module
JavaScript
3
star
30

discussions

Open organization discussions
3
star
31

ts-node-examples

TypeScript
2
star