mkdocstrings-typescript

A Typescript handler for mkdocstrings.

WARNING: Still in prototyping phase! Feedback is welcome.

Installation

pip install mkdocstrings-typescript

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

You can set the Typescript handler as default handler:

plugins:
- mkdocstrings:
    default_handler: typescript

By setting it as default handler you can omit it when injecting documentation:

::: @owner/packageName

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for mkdocstrings-typescript 0.1.0
File	Size	Uploaded
mkdocstrings_typescript-0.1.0.tar.gz	52.5 kB	Mar 24, 2025	Details

Table of built distributions (wheels) for mkdocstrings-typescript 0.1.0
File	Interpreter	ABI	Platform	Reset
mkdocstrings_typescript-0.1.0-py3-none-any.whl 36.1 kB Mar 24, 2025	Python 3	none	any	Details

Total release size: 88.6 kB

Download URL	mkdocstrings_typescript-0.1.0.tar.gz
Size	52.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`cee525df74a1a9967e00ba14fb05b7588512ad7ce10677bbb7ddebcfc934488f`
BLAKE2b-256 checksum How to use checksums	`4bb43ed53f5bbd83355d10a1927251ee4ea8dc958529e93d8e018b55def84091`
Upload date	Mar 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`

Download URL	mkdocstrings_typescript-0.1.0-py3-none-any.whl
Size	36.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2221bd4ad2a10d74f424c9c2d9ed6ae7b347574ae464f7e282f524f3b794d904`
BLAKE2b-256 checksum How to use checksums	`373a4a5b4a3b9831ea5e0286c31e9d5b2fc4de4101b5fe64a47ea0692b7d822a`
Upload date	Mar 24, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`