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

TypeScript 支持

设置#

Docusaurus 支持编写和使用 TypeScript 主题组件。 要开始使用 TypeScript,请将 @docusaurus/module-type-aliases 和一些 @types 依赖关系添加到您的项目:

npm install --save-dev typescript @docusaurus/module-type-aliases @types/react @types/react-router-dom @types/react-helmet @tsconfig/docusaurus

随后将以下内容添加到您的项目根目录的 tsconfig.json

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

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

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

变换 TypeScript 主题组件#

对于支持 TypeScript 的主题组件,您可于变换(Swizzling)命令末尾添加 --typescript 参数以获取 TypeScript 源代码。 举个例子,下列代码将生成 index.tsxstyles.module.csssrc/theme/Footer

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

迄今为止,支持 TypeScript 主题组件的唯一 Docusaurus 官方主题是 @docusaurus/theme-classic。 如果您是一位 Docusaurus 主题作者,且想要添加 TypeScript 支持,请参阅生命周期 API 文档