mkdocstrings-typescript¤

A Typescript handler for mkdocstrings.

Installation¤

This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.

Usage¤

Add these TypeDoc configuration files to your repository:

📁 ./
├── 📁 src/
│   └── 📁 package1/
├──  typedoc.base.json
└──  typedoc.json

{
  "$schema": "https://typedoc.org/schema.json",
  "includeVersion": true
}

{
  "extends": ["./typedoc.base.json"],
  "entryPointStrategy": "packages",
  "entryPoints": ["./src/*"]
}

Update the entrypoints to match your file layout so that TypeDoc can find your packages. See TypeDoc's configuration documentation.

Then in each of your package, add this TypeDoc configuration file:

📁 ./
├── 📁 src/
│   └── 📁 package1/
│       └──  typedoc.json
├──  typedoc.base.json
└──  typedoc.json

{
  "extends": ["../../typedoc.base.json"],
  "entryPointStrategy": "expand",
  "entryPoints": ["src/index.d.ts"]
}

Again, update entrypoints to match your file and package layout. See TypeDoc's configuration documentation.

Your packages must be built for TypeDoc to work.

You are now able to use the TypeScript handler to inject API docs in your Markdown pages by referencing package names:

::: @owner/packageName
    handler: typescript