对 TypeScript 的支持
由于 Docusaurus 是使用 TypeScript 开发的,因此完全支持 TypeScript。
初始化
Docusaurus 支持编写和使用采用 TypeScript 开发的主题组件。如果你选择的初始化模板提供了对 Typescript 的支持,那么你就可以通过 --typescript
标志来初始化一个完全支持 TypeScript 的站点。
npx create-docusaurus@latest my-website classic --typescript
以下是一些关于如何将现有项目迁移到 TypeScript 的指南。
安装设置
想要使用 TypeScript 开发的话,请在项目中添加 @docusaurus/module-type-aliases
插件以及一些基础的 TS 配置:
- npm
- Yarn
- pnpm
npm install --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig
yarn add --dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig
pnpm add --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig
然后在项目的根目录下添加 tsconfig.json
文件,此文件包含的内容如下:
{
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": "."
}
}
Docusaurus 在编译您的项目时并不会用到 tsconfig.json
文件。添加此文件的目的只是为了获得更好的编辑器体验(虽然您可以通过手工或在 CI 上运行 tsc
来对你的代码进行类型检查)。
现在就可以用 TypeScript 来编写主题组件了。
Typing the config file
除非你自己将 TypeScript 的配置文件编译为 JavaScript,否则 不能 在 Docusaurus 中使用 TypeScript 的配置文件。
我们建议使用 JSDoc 所支持的类型注释:
// @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;
类型注释(Type annotations)非常有用,可以帮助 IDE 理解配置对象(config objects)的类型!
优秀的 IDE(例如 VS Code、WebStorm、IntelliJ 等)都提供了良好的自动完成功能。
默认情况下,Docusaurus 的 TypeScript 配置并不对 JavaScript 文件做类型检查。
// @ts-check
注释可以确保在运行 npx tsc
时对配置文件做适当的类型检查。
覆盖 TypeScript 编写的主题组件
对于支持 TypeScript 主题组件的主题,你可以在 swizzle
命令的末尾添加 --typescript
参数来获取该组件的 TypeScript 源码。例如,以下命令将在 src/theme/Footer
目录下生成 index.tsx
和 styles.module.css
两个文件。
- npm
- Yarn
- pnpm
npm run swizzle @docusaurus/theme-classic Footer -- --typescript
yarn swizzle @docusaurus/theme-classic Footer --typescript
pnpm run swizzle @docusaurus/theme-classic Footer -- --typescript
Docusaurus 官方提供的所有主题都支持 TypeScript 主题组件,包括 theme-classic
, theme-live-codeblock
和theme-search-algolia
。如果你是一个 Docusaurus 主题作者,想要添加对 TypeScript 的支持的话,请参阅 声明周期 API 文档。