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 檔。

當執行 npx tsc 時，// @ts-check 註解可確保類型檢查設定檔的正確執行。

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 主題組件的主題，您可以將 --typescript 旗標新增至 swizzle 指令的結尾，以取得 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 文件。