TypeDoc Config

TypeDoc configuration for ApiTree projects

Installation

pnpm add --save-dev @apitree.cz/typedoc-config typedoc typescript

In a monorepo, install the package in the root, then create configs in each workspace.

Usage

Add the following configuration to your typedoc.config.js:

export { config as default } from '@apitree.cz/typedoc-config';

Custom Entry Points

The default configuration picks ./src/index.ts in your package as the documentation entry point, however, you can change this by overriding the entryPoints property in your typedoc.config.js:

import { config } from '@apitree.cz/typedoc-config';

export default {
  ...config,
  entryPoints: ['./src/module-a/index.ts', './src/module-b/index.ts'],
};

See Options documentation for config reference.