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，您可以及早发现错误，提高代码质量，并通过更好的自动完成和类型推断增强开发者体验。