Skip to main content
Version: Canary 🚧

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: '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;
It is also possible to use JSDoc type annotations within a .js file:

默认情况下，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',

  /* 您的站点配置在这里 */

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

export default config;

tip

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

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

Swizzling 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。如果你是Docusaurus主题包的作者，想要添加TypeScript支持，请参阅生命周期API文档。