TypeScript 支持
Docusaurus 由 TypeScript 写成,并提供一流的 TypeScript 支持。
所需的最低版本是 TypeScript 5.1。
初始化
Docusaurus 支持编写和使用 TypeScript 主题组件。 如果初始化模板提供了 TypeScript 变种,你可以用 --typescript
选项直接初始化一个包含完整 TypeScript 支持的网站 。
npx create-docusaurus@latest my-website classic --typescript
下面是一些关于如何将现有项目迁移到 TypeScript 的指南。
设置
将下列软件包添加到您的项目:
- npm
- Yarn
- pnpm
npm install --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types
yarn add --dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types
pnpm add --save-dev typescript @docusaurus/module-type-aliases @docusaurus/tsconfig @docusaurus/types
随后在你的项目根目录的 tsconfig.json
中添加如下内容:
tsconfig.json
{
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": "."
}
}