# @itsjamie/typedoc > Create api documentation for TypeScript projects. Latest version **0.21.9** (published 2021-09-07) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @itsjamie/typedoc pnpm add @itsjamie/typedoc yarn add @itsjamie/typedoc bun add @itsjamie/typedoc ``` Provides the command `typedoc`. ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.21.9 | | Published | 2021-09-07 | | First published | 2021-09-07 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 12.10.0 | | Dependencies | 8 | | Unpacked size | 798.1 KB | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 8452 | | Maintainers | itsjamie | | Keywords | typescript, documentation, generator | ## Links - npm: https://www.npmjs.com/package/@itsjamie/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/@itsjamie/typedoc ## Dependencies (8) - [glob](https://npm.io/package/glob.md) ^7.1.7 - [lunr](https://npm.io/package/lunr.md) ^2.3.9 - [shiki](https://npm.io/package/shiki.md) ^0.9.8 - [marked](https://npm.io/package/marked.md) ^3.0.2 - [progress](https://npm.io/package/progress.md) ^2.0.3 - [minimatch](https://npm.io/package/minimatch.md) ^3.0.0 - [handlebars](https://npm.io/package/handlebars.md) ^4.7.7 - [typedoc-default-themes](https://npm.io/package/typedoc-default-themes.md) ^0.12.10 ## 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.21.9 (latest) — 2021-09-07 ## README # TypeDoc Documentation generator for TypeScript projects. ![CI](https://github.com/TypeStrong/typedoc/workflows/CI/badge.svg) ![NPM Version](https://badge.fury.io/js/typedoc.svg) ## 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, so you can just specify the entry point of your library: ```text typedoc src/index.ts ``` If you have multiple entry points, specify each of them. If you specify a directory, TypeDoc will treat each file contained within it as an entry point. ```text typedoc package1/index.ts package2/index.ts ``` ### Monorepos / Workspaces If your codebase is comprised of one or more npm packages, you can pass the paths to these packages and TypeDoc will attempt to determine entry points based on `package.json`'s `main` property (with default value `index.js`) and if it wasn't found, based on `types` property. If any of the packages given are the root of an [npm Workspace](https://docs.npmjs.com/cli/v7/using-npm/workspaces) or a [Yarn Workspace](https://classic.yarnpkg.com/en/docs/workspaces/) TypeDoc will find all the `workspaces` defined in the `package.json`. This mode requires sourcemaps in your JS entry points, in order to find the TS entry points. Supports wildcard paths in the same fashion as those found in npm or Yarn workspaces. #### Single npm module ```text typedoc --packages . ``` #### Monorepo with npm/Yarn workspace at the root ```text typedoc --packages . ``` #### Monorepo with manually specified sub-packages to document This can be useful if you do not want all your workspaces to be processed. Accepts the same paths as would go in the `package.json`'s workspaces ```text # Note the single quotes prevent shell wildcard expansion, allowing typedoc to do the expansion typedoc --packages a-package --packages 'some-more-packages/*' --packages 'some-other-packages/*' ``` ### Arguments For a complete list of the command line arguments run `typedoc --help` or visit [our website](https://typedoc.org/guides/options/). - `--out `
Specifies the location the documentation should be written to. Defaults to `./docs` - `--json `
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated. - `--options`
Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory. - `--packages `
Specify one or more sub packages, or the root of a monorepo with workspaces. Supports wildcard paths in the same fashion as those found in npm or Yarn workspaces. - `--tsconfig `
Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory. #### Source file handling - `--exclude `
Exclude files by the given pattern when a path is provided as source. Supports standard minimatch patterns. - `--excludeNotDocumented`
Only document items which have a doc comment. This option is useful, if you want to document only small part of your symbols and do not show the remaining ones in the documentation. #### Theming - `--theme `
Specify the path to the theme that should be used. - `--name `
Set the name of the project that will be used in the header of the template. - `--readme `
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 - `--listInvalidSymbolLinks`
Display the list of links that don't point to actual code symbols. - `--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](https://github.com/TypeStrong/typedoc/blob/master/.github/CONTRIBUTING.md). ## License Copyright (c) 2015 [Sebastian Lenz](https://typedoc.org).
Copyright (c) 2016-2020 [TypeDoc Contributors](https://github.com/TypeStrong/typedoc/graphs/contributors).
Licensed under the Apache License 2.0. --- _Source: https://npm.io/package/@itsjamie/typedoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._