From 0e52193eec161826c3e0349d69f97f202bfb1eb0 Mon Sep 17 00:00:00 2001 From: Gerrit Birkeland Date: Thu, 2 Jan 2025 16:03:12 -0700 Subject: [PATCH] Update docs for TypeDoc import Resolves #2826 --- site/development/internationalization.md | 2 +- site/development/plugins.md | 2 +- site/overview.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/site/development/internationalization.md b/site/development/internationalization.md index 6d21f1aea..6b752045e 100644 --- a/site/development/internationalization.md +++ b/site/development/internationalization.md @@ -66,7 +66,7 @@ declared in the `TranslatableStrings` interface. To do this, use declaration merging to define the expected number of placeholders for each translation string. ```ts -import td from "typedoc"; +import * as td from "typedoc"; declare module "typedoc" { interface TranslatableStrings { diff --git a/site/development/plugins.md b/site/development/plugins.md index 02a14d5b5..901065d91 100644 --- a/site/development/plugins.md +++ b/site/development/plugins.md @@ -18,7 +18,7 @@ generally published as ESM to avoid `require(esm)` experimental warnings. ```js // @ts-check -import td from "typedoc"; +import * as td from "typedoc"; /** @param {td.Application} app */ export function load(app) { // Add event listeners to app, app.converter, etc. diff --git a/site/overview.md b/site/overview.md index 3cccf0542..c246a96df 100644 --- a/site/overview.md +++ b/site/overview.md @@ -46,7 +46,7 @@ for details on where options are read from. TypeDoc exposes an API which can be used to run it without any configuration files. ```js -import td from "typedoc"; +import * as td from "typedoc"; // Application.bootstrap also exists, which will not load plugins // Also accepts an array of option readers if you want to disable