@kayahr/typedoc

GitHub | NPM

A drop-in replacement for typedoc, bundling typedoc and its dependencies into a single module.

This package temporarily bundles TypeScript 6 so it can be used in projects that otherwise use TypeScript 7 without causing dependency conflicts. This compatibility measure only works if the project's source code and TypeScript configuration are also supported by TypeScript 6. It can be removed once TypeDoc supports TypeScript 7 natively.

This package is primarily for my own use as a single dev dependency across my projects, to centralize the review of updates for the dependencies that typedoc brings along, and to reduce the threat of a supply-chain attack. Use at your own risk.

Usage

Install as development dependency:

npm install -DE @kayahr/typedoc

Usage is the same as with the original typedoc, so check upstream documentation for more info.

Plugins

This bundle includes the following two plugins:

• typedoc-github-theme
• typedoc-plugin-mdn-links

The bundled plugins can be loaded like this in typedoc.json:

{
    "plugin": [
        "@kayahr/typedoc/github-theme",
        "@kayahr/typedoc/mdn-links"
    ]
}

Other plugins require the bundle to be referenced as a forked dependency and override in package.json. Example:

{
    "overrides": {
        "typedoc": "npm:@kayahr/[email protected]"
    },
    "devDependencies": {
        "typedoc": "npm:@kayahr/[email protected]"
    }
}