跳转至主内容
Version: 2.0.0-beta.20

TypeScript 支持

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

初始化

Docusaurus 支持编写和使用 TypeScript 主题组件。 If the init template provides a TypeScript variant, you can directly initialize a site with full TypeScript support by using the --typescript flag.

npx [email protected] 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"
}

Docusaurus 不会使用此 tsconfig.json 来编译您的项目。 这只是为了改善您的编辑体验,虽然您也可以选择自己或在持续集成上运行 tsc 来类型检查您的代码。

现在,您可以开始撰写 TypeScript 主题组件了。

类型化配置文件

It is not possible to use a TypeScript config file in Docusaurus unless you compile it yourself to 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;
tip

类型注解非常有用,它能够帮助您的 IDE 理解配置对象的类型!

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

信息

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

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

变换 TypeScript 主题组件

对于支持 TypeScript 的主题组件,您可于变换(swizzle)命令末尾添加 --typescript 参数以获取 TypeScript 源代码。 举个例子,下列代码将生成 index.tsxstyles.module.csssrc/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. 如果您是一位 Docusaurus 主题作者,且想要添加 TypeScript 支持,请参阅生命周期 API 文档