# @apitree.cz/typedoc-config

> TypeDoc configuration for ApiTree projects.

Latest version **1.0.3** (published 2026-09-01) · 0 weekly downloads

## Install

```sh
npm install @apitree.cz/typedoc-config
pnpm add @apitree.cz/typedoc-config
yarn add @apitree.cz/typedoc-config
bun add @apitree.cz/typedoc-config
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2026-09-01 |
| First published | 2023-10-31 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Maintainers | vitrozsival.apitree, ales.dostal |
| Keywords | apitree, typedoc, config |

## Links

- npm: https://www.npmjs.com/package/@apitree.cz/typedoc-config
- Repository: https://github.com/ApiTreeCZ/toolbox
- Homepage: https://github.com/ApiTreeCZ/toolbox#readme
- Issues: https://github.com/ApiTreeCZ/toolbox/issues
- npm.io page: https://npm.io/package/@apitree.cz/typedoc-config

## Dependencies (1)

- [typedoc-plugin-markdown](https://npm.io/package/typedoc-plugin-markdown.md) ^4.13.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2026-09-01
- 1.0.3-next.457390effe8cbffc91295e904dafab6ba1c347eb (next) — 2026-09-01
- 1.0.2 — 2026-07-11
- 1.0.2-next.f645ea1b914f5d5e788bff8eaaa16b4aa9077528 — 2026-07-11
- 1.0.1 — 2026-06-02
- 1.0.1-next.928777c694c0db5b0901901f287f8f4f29f7d491 — 2026-06-02
- 1.0.0 — 2026-05-28
- 1.0.0-next.e065c160ede50bd8b05ed5aa679870cfe299b14a — 2026-05-28
- 0.3.2 — 2026-05-13
- 0.3.2-next.722b12639efdbdaa6bb53916d220c93e4634c583 — 2026-05-13
- 0.3.1 — 2026-04-08
- 0.3.1-next.95c4f6cb728484a8222b277979a34422c2cabc16 — 2026-04-08
- 0.3.0 — 2026-04-07
- 0.3.0-next.ebf7c38f47bc62587865cde8e83d43754ab4131c — 2026-04-07
- 0.3.0-next.4c4bdd00e224489b0b74b5e80360f5d4434885db — 2026-04-07
- … 85 more at https://npm.io/package/@apitree.cz/typedoc-config/versions

## README

<div align="center">

<a href="https://github.com/ApiTreeCZ">
<img alt="ApiTree s.r.o." src="../../public/apitree-logo.png" width="308" />
</a>

# TypeDoc Config

[![NPM Version](https://img.shields.io/npm/v/%40apitree.cz%2Ftypedoc-config)](https://www.npmjs.com/package/@apitree.cz/typedoc-config)

### [TypeDoc](https://typedoc.org) configuration for ApiTree projects

</div>

## Installation

```bash
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`:

```javascript
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`:

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

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

> See [Options](https://typedoc.org/options/) documentation for config reference.

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