TypeScript 支持

Docusaurus 是用 TypeScript 编写的，并提供一流的 TypeScript 支持。

最低要求版本为 TypeScript 5.1。

初始化

Docusaurus 支持编写和使用 TypeScript 主题组件。如果初始化模板提供了 TypeScript 变体，您可以使用 --typescript 标志直接初始化具有完整 TypeScript 支持的站点。

npx create-docusaurus@latest my-website classic --typescript

以下是一些有关如何将现有项目迁移到 TypeScript 的指南。

设置

将以下包添加到您的项目中

npm

npm install --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types

Yarn

yarn add --dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types

pnpm

pnpm add --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types

然后将 tsconfig.json 添加到您的项目根目录，并使用以下内容：

tsconfig.json

{
  "extends": "@docusaurus/tsconfig",
  "compilerOptions": {
    "baseUrl": "."
  }
}

Docusaurus 不使用此 tsconfig.json 来编译您的项目。它只是为了提供更好的编辑器体验而添加的，尽管您可以选择运行 tsc 来自行或在 CI 上对您的代码进行类型检查。

现在您可以开始编写 TypeScript 主题组件。

为配置文件键入

在 Docusaurus 中可以使用 TypeScript 配置文件。

docusaurus.config.ts

import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
  title: 'My Site',
  favicon: 'img/favicon.ico',

  /* Your site config here */

  presets: [
    [
      'classic',
      {
        /* Your preset config here */
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    /* Your theme config here */
  } satisfies Preset.ThemeConfig,
};

export default config;

也可以在 .js 文件中使用 JSDoc 类型注解

默认情况下，Docusaurus TypeScript 配置不会对 JavaScript 文件进行类型检查。

// @ts-check 注释确保在运行 npx tsc 时正确地对配置文件进行类型检查。

docusaurus.config.js

// @ts-check

/** @type {import('@docusaurus/types').Config} */
const config = {
  tagline: 'Dinosaurs are cool',
  favicon: 'img/favicon.ico',

  /* Your site config here */

  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      (
        {
          /* Your preset config here */
        }
      ),
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    (
      {
        /* Your theme config here */
      }
    ),
};

export default config;

提示

类型注解非常有用，可以帮助您的 IDE 了解配置文件对象的类型！

最好的 IDE（VS Code、WebStorm、IntelliJ...）将提供良好的自动完成体验。

改写 TypeScript 主题组件

对于支持 TypeScript 主题组件的主题，您可以在 swizzle 命令末尾添加 --typescript 标志以获取 TypeScript 源代码。例如，以下命令将生成 index.tsx 和 styles.module.css 到 src/theme/Footer 中。

npm

npm run swizzle @docusaurus/theme-classic Footer -- --typescript

Yarn

yarn swizzle @docusaurus/theme-classic Footer --typescript

pnpm

pnpm run swizzle @docusaurus/theme-classic Footer --typescript

所有官方的 Docusaurus 主题都支持 TypeScript 主题组件，包括 theme-classic、theme-live-codeblock 和 theme-search-algolia。如果您是想要添加 TypeScript 支持的 Docusaurus 主题包作者，请查看 生命周期 API 文档。