Ir para o conteúdo principal
Version: 2.0.0-beta.8

Suporte a TypeScript

Docusaurus is written in TypeScript, and provides first-class TypeScript support.

Inicialização

O Docusaurus suporta escrever e usar componentes de temas TypeScript. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the --typescript flag.

npm init [email protected] my-website classic -- --typescript

Below are some guides on how to migrate an existing project to TypeScript.

Configuração

To start using TypeScript, add @docusaurus/module-type-aliases and the base TS config to your project:

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

Em seguida, adicione o tsconfig.json à raiz do seu projeto com o seguinte conteúdo:

tsconfig.json
{
"extends": "@tsconfig/docusaurus/tsconfig.json",
"include": ["src/"]
}

O Docusaurus não usa este tsconfig.json para compilar seu projeto. É adicionado apenas para uma experiência do Editor mais agradável, embora você possa optar por executar tsc para digitar seu código para si mesmo ou no CI.

Agora você pode começar a escrever componentes de tema TypeScript.

Typing the config file

It is not possible to use a TypeScript config file in Docusaurus, unless you compile it yourself to JavaScript.

We recommend using JSDoc type annotations:

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;
tip

Type annotations are very useful and help your IDE understand the type of config objects!

The best IDEs (VSCode, WebStorm, Intellij...) will provide a nice auto-completion experience.

info

By default, the Docusaurus TypeScript config does not type-check JavaScript files.

The // @ts-check comment ensures the config file is properly type-checked when running:

npm run tsc

Componentes de tema TypeScript Swizzling

Para temas que suportam componentes de tema TypeScript, você pode adicionar a flag --typescript no final do comando swizzling para obter o código fonte TypeScript. Por exemplo, o seguinte comando irá gerar index.tsx e styles.module.css em src/theme/Footer.

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

Até agora, o único tema oficial do Docusaurus que suporta componentes do tema TypeScript é @docusaurus/theme-classic. Se você é um autor de um tema do Docusaurus que quer adicionar suporte ao TypeScript, consulte Documentos de APIs de ciclo de vida.