Nextra 3.0 發佈了。 了解更多

TypeScript

Nextra 使用 TypeScript 構建,並提供開箱即用的出色 TypeScript 支援。本指南將幫助您在 Nextra 專案中利用 TypeScript。

開始使用

要在 Nextra 專案中使用 TypeScript,您需要

將 TypeScript 和類型套件安裝為 devDependencies

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

tsconfig.json

您可以手動在專案的根目錄中建立一個 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 = {
  // Your theme configuration
}
export default config

透過在 Nextra 專案中利用 TypeScript,您可以及早發現錯誤,提高程式碼品質,並透過更好的自動完成和類型推斷來增強開發體驗。