跳到主要内容
版本：2.3.1

TypeScript 支持

Docusaurus 由 TypeScript 写成，并提供一流的 TypeScript 支持。

初始化​

Docusaurus 支持编写和使用 TypeScript 主题组件。 如果初始化模板提供了 TypeScript 变种，你可以用 --typescript 选项直接初始化一个包含完整 TypeScript 支持的网站。

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

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

设置​

要开始使用 TypeScript，请在你的项目中添加 @docusaurus/module-type-aliases 和 TypeScript 基础配置：

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

随后在你的项目根目录的 tsconfig.json 中添加如下内容：

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

Docusaurus 不会用这个 tsconfig.json 来编译你的项目。 这只是为了改善你的编辑体验。不过你也可以选择自己在本地或在 CI 上运行 tsc 来对你的代码做类型检查。

现在，你可以开始撰写 TypeScript 主题组件了。

为配置文件添加类型​

使用 TypeScript 编写 Docusaurus 配置文件尚不可能，除非你自己把它编译成 JavaScript。

我们建议使用 JSDoc 类型注释：

docusaurus.config.js
// @ts-check

/** @type {import('@docusaurus/types').Plugin} */
function MyPlugin(context, options) {
  return {
    name: 'my-plugin',
  };
}

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Docusaurus',
  tagline: 'Build optimized websites quickly, focus on your content',
  organizationName: 'facebook',
  projectName: 'docusaurus',
  plugins: [MyPlugin],
  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          path: 'docs',
          sidebarPath: 'sidebars.js',
        },
        blog: {
          path: 'blog',
          postsPerPage: 5,
        },
      }),
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: 'dark',
      },
      navbar: {
        hideOnScroll: true,
        title: 'Docusaurus',
        logo: {
          alt: 'Docusaurus Logo',
          src: 'img/docusaurus.svg',
          srcDark: 'img/docusaurus_keytar.svg',
        },
      },
    }),
};

module.exports = config;
提示

类型注解非常有用，它能够帮助你的编辑器理解配置对象的类型！

最好的编辑器（VSCode、WebStorm、IntelliJ，等等）会给你提供优秀的自动补全。

信息

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

// @ts-check 注释会确保在运行 npx tsc 时，配置文件可以被类型检查。

Swizzle TypeScript 主题组件​

对于支持 TypeScript 的主题组件，你可以在 swizzle 命令末尾添加 --typescript 参数，以获取 TypeScript 源码。 举个例子，下列代码会在 src/theme/Footer 中生成 index.tsx 和 styles.module.css。

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

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