國際化

開始之前

Fumadocs 不是一個功能齊全的 i18n 函式庫，它只管理自己的元件和工具程式。

你可以使用其他函式庫，如 next-intl，用於應用程式的其餘部分。閱讀 Next.js 文件，了解更多關於在 Next.js 中實作 I18n 的資訊。

手動設定

在一個檔案中定義 i18n 設定，我們將在本指南中使用 @/ilb/i18n 匯入它。

將其傳遞給來源載入器。

lib/source.ts

import { i18n } from '@/lib/i18n';
import { loader } from 'fumadocs-core/source';

export const source = loader({
  i18n, 
  // other options
});

並更新 Fumadocs UI 佈局選項。

app/layout.config.tsx

import { i18n } from '@/lib/i18n';
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

export function baseOptions(locale: string): BaseLayoutProps {
  return {
    i18n,
    // different props based on `locale`
  };
}

中介軟體

建立一個將使用者重導向到適當語言環境的中介軟體。

{
  "file": "../../examples/i18n/middleware.ts",
  "codeblock": {
    "lang": "ts",
    "meta": "title=\"middleware.ts\""
  }
}

查看中介軟體了解可自訂選項。

請注意，這是可選的，你也可以使用自己的中介軟體或 i18n 函式庫提供的中介軟體。

路由

建立一個 /app/[lang] 資料夾，並將所有檔案（例如 page.tsx、layout.tsx）從 /app 移動到該資料夾。

將根提供者包裝在 I18nProvider 中，並向其提供可用語言和翻譯。請注意，預設情況下只提供英文翻譯。

app/[lang]/layout.tsx

import { RootProvider } from 'fumadocs-ui/provider';
import { I18nProvider, type Translations } from 'fumadocs-ui/i18n';

const cn: Partial<Translations> = {
  search: 'Translated Content',
  // other translations
};

// available languages that will be displayed on UI
// make sure `locale` is consistent with your i18n config
const locales = [
  {
    name: 'English',
    locale: 'en',
  },
  {
    name: 'Chinese',
    locale: 'cn',
  },
];

export default async function RootLayout({
  params,
  children,
}: {
  params: Promise<{ lang: string }>;
  children: React.ReactNode;
}) {
  const lang = (await params).lang;

  return (
    <html lang={lang}>
      <body>
        <I18nProvider
          locale={lang}
          locales={locales}
          translations={{ cn }[lang]}
        >
          <RootProvider>{children}</RootProvider>
        </I18nProvider>
      </body>
    </html>
  );
}

傳遞語言環境

在你的頁面和佈局中將語言環境傳遞給 Fumadocs。

搜尋

在你的搜尋解決方案上設定 i18n。

內建搜尋 (Orama)： 對於支援的語言，無需進一步變更。

否則，需要額外設定（例如中文和日文）。請參閱特殊語言。
雲端解決方案（例如 Algolia）： 它們通常官方支援多語言。

手動設定

中介軟體

路由

傳遞語言環境

搜尋

撰寫文件

導航

目錄