# typedoc

> Create api documentation for TypeScript projects.

Latest version **0.28.20** (published 2026-07-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install typedoc
pnpm add typedoc
yarn add typedoc
bun add typedoc
```

Provides the command `typedoc`.

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.28.20 |
| Published | 2026-07-05 |
| First published | 2014-05-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM |
| Node | >= 18 |
| Dependencies | 5 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8453 |
| Maintainers | blakeembrey, sebastian-lenz, aciccarello, gerrit0, typedoc-bot |
| Keywords | typescript, documentation, generator |

## Links

- npm: https://www.npmjs.com/package/typedoc
- Repository: https://github.com/TypeStrong/TypeDoc
- Homepage: https://typedoc.org
- Issues: https://github.com/TypeStrong/TypeDoc/issues
- npm.io page: https://npm.io/package/typedoc

## Dependencies (5)

- [lunr](https://npm.io/package/lunr.md) ^2.3.9
- [yaml](https://npm.io/package/yaml.md) ^2.9.0
- [minimatch](https://npm.io/package/minimatch.md) ^10.2.5
- [markdown-it](https://npm.io/package/markdown-it.md) ^14.3.0
- [@gerrit0/mini-shiki](https://npm.io/package/@gerrit0/mini-shiki.md) ^3.23.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.28.20 (latest) — 2026-07-05
- 0.28.0-beta.2 (beta) — 2025-03-10
- 0.28.19 — 2026-04-12
- 0.28.18 — 2026-03-23
- 0.28.17 — 2026-02-13
- 0.28.16 — 2026-01-12
- 0.28.15 — 2025-11-29
- 0.28.14 — 2025-10-11
- 0.28.13 — 2025-09-14
- 0.28.12 — 2025-09-01
- 0.28.11 — 2025-08-25
- 0.28.10 — 2025-08-10
- 0.28.9 — 2025-08-01
- 0.28.8 — 2025-07-28
- 0.28.7 — 2025-06-30
- … 335 more at https://npm.io/package/typedoc/versions

## README

# TypeDoc

Documentation generator for TypeScript projects.

## 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.

```text
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 and figure
out your entry points from `package.json`, so you can probably run TypeDoc without any options:

```text
typedoc
```

If TypeDoc does not automatically choose the entry points you wanted, you can specify them
manually:

```text
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

### Options

TypeDoc can be configured with command line arguments or a configuration file.
Visit [TypeDoc's site](https://typedoc.org/documents/Options.html) for a list
of available options. Some commonly used options are:

- `--out <path/to/documentation/>`<br>
  Specifies the location the documentation should be written to. Defaults to `./docs`
- `--json <path/to/output.json>`<br>
  Specifies the location and file name a json file describing the project is
  written to. When specified no HTML documentation will be generated unless `--out` is also
  specified.
- `--options`<br>
  Specify a json option file that should be loaded. If not specified TypeDoc
  will check for several common file names in the current directory.
- `--tsconfig <path/to/tsconfig.json>`<br>
  Specify a typescript config file that should be loaded. If not
  specified TypeDoc will look for `tsconfig.json` in the current directory.

#### Theming

- `--theme <default|plugin defined theme>`<br>
  Specify the theme that should be used.
- `--name <Documentation title>`<br>
  Set the name of the project that will be used in the header of the template.
- `--readme <path/to/readme|none>`<br>
  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`<br>
  Display the version number of TypeDoc.
- `--help`<br>
  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](https://github.com/TypeStrong/typedoc/blob/master/.github/CONTRIBUTING.md).

---
_Source: https://npm.io/package/typedoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._