跳到主要内容

TypeScript 支持

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

最低要求版本是 TypeScript 5.1。

初始化​

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

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

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

设置​

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

npm install --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: '我的网站',
  favicon: 'img/favicon.ico',

  /* 在此处添加您的站点配置 */

  presets: [
    [
      'classic',
      {
        /* 在此处添加您的预设配置 */
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    /* 在此处添加您的主题配置 */
  } 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: '恐龙很酷',
  favicon: 'img/favicon.ico',

  /* 在此处添加您的站点配置 */

  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      (
        {
          /* 在此处添加您的预设配置 */
        }
      ),
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    (
      {
        /* 在此处添加您的主题配置 */
      }
    ),
};

export default config;
提示

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

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

混合 TypeScript 主题组件​

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

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

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