TypeScript

Nextra 使用 TypeScript 构建，并开箱即用地提供了优秀的 TypeScript 支持。本指南将帮助您在 Nextra 项目中利用 TypeScript。

快速开始

要在 Nextra 项目中使用 TypeScript，您需要：


npm i -D typescript @types/react @types/node


pnpm add -D typescript @types/react @types/node


yarn add --dev typescript @types/react @types/node


bun add --dev typescript @types/react @types/node

您可以在项目根目录手动创建一个 tsconfig.json 文件，或者将某些现有文件的扩展名重命名为 .ts 或 .tsx，然后 Next.js 将检测到项目中的 TypeScript 并为您创建一个 tsconfig.json 文件。

Nextra 为其组件和配置的分发代码提供了类型定义。您可以通过将主题配置文件重命名为 .ts 或 .tsx 扩展名并导入主题配置类型来利用这些类型，例如对于 nextra-theme-docs：

theme.config.tsx


import type { DocsThemeConfig } from 'nextra-theme-docs'
 
const config: DocsThemeConfig = {
  // 您的主题配置
}
export default config

通过在 Nextra 项目中利用 TypeScript，您可以及早捕获错误，提高代码质量，并通过更好的自动补全和类型推断来提升开发者体验。