Skip to main content
버전: 불안정 🚧

타입스크립트 지원

도큐사우루스는 타입스크립트로 작성됐으며 최고 수준의 타입스크립트 지원을 제공합니다.

The minimum required version is TypeScript 6.0.

초기화​

도큐사우루스는 타입스크립트 테마 컴포넌트를 작성하고 사용하는 것을 지원합니다. If the init template provides a TypeScript variant, you can directly initialize a site with full TypeScript support by using the --typescript flag.

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

아래 내용은 기존 프로젝트를 타입스크립트로 마이그레이션하는 방법에 대한 가이드입니다.

설치하기​

Add the following packages to your project:

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

Then add tsconfig.json to your project root with the following content:

tsconfig.json
{
  "extends": "@docusaurus/tsconfig",
  "compilerOptions": {
    "types": ["node"]
  }
}

Docusaurus doesn't use this tsconfig.json to compile your project. It is added just for a nicer Editor experience, although you can choose to run tsc to type check your code for yourself or on CI.

이제 타입스크립트 테마 컴포넌트를 작성할 수 있습니다.

Ambient types for optional plugins​

Some plugins and themes ship their own ambient .d.ts files that TypeScript does not load automatically.

For example, importing from @theme/Playground (provided by @docusaurus/theme-live-codeblock) fails with TS2307: Cannot find module '@theme/Playground' until you opt the plugin's types in.

Add a triple-slash reference in a project .d.ts file (recommended):

src/types.d.ts
/// <reference types="@docusaurus/theme-live-codeblock" />

Alternatively, add the package to the types compiler option of your tsconfig.json:

tsconfig.json
{
  "extends": "@docusaurus/tsconfig",
  "compilerOptions": {
    "types": ["node", "@docusaurus/theme-live-codeblock"]
  }
}

The same applies to any other optional plugin or theme that ships ambient types.

설정 파일 작성하기​

It is possible to use a TypeScript config file in Docusaurus.

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:

기본적으로 도큐사우루스의 타입스크립트 설정은 자바스크립트 파일에 대한 타입 체크는 하지 않습니다.

The // @ts-check comment ensures the config file is properly type-checked when running 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에서 설정 오브젝트 타입을 이해하는데 도움이 됩니다!

The best IDEs (VS Code, WebStorm, IntelliJ...) will provide a nice auto-completion experience.

타입스크립트 테마 컴포넌트 활용하기​

For themes that support TypeScript theme components, you can add the --typescript flag to the end of the swizzle command to get TypeScript source code. For example, the following command will generate index.tsx and styles.module.css into src/theme/Footer.

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

All official Docusaurus themes support TypeScript theme components, including theme-classic, theme-live-codeblock, and theme-search-algolia. If you are a Docusaurus theme package author who wants to add TypeScript support, see the Lifecycle APIs docs.