# Fumadocs (Framework Mode, Waku): 國際化
URL: /zh-TW/docs/waku/internationalization
Source: https://raw.githubusercontent.com/fuma-nama/fumadocs/refs/heads/main/apps/docs/content/docs/(framework)/[framework]/internationalization.zh-TW.mdx

讓您的 Waku 文件支援多種語言。

<Callout title="Fumadocs CLI">
執行 `npx @fumadocs/cli init --i18n` 即可建立支援 i18n 的新文件網站，您也可以依照下方說明手動設定。
</Callout>

## 概覽 [#overview]

請在 Waku 與 Fumadocs 兩端設定 i18n 路由。

Fumadocs 會負責文件內容與側邊欄的 i18n。應用程式的其他部分，請透過您自己的 i18n 設定來進行國際化。

## 設定 [#setup]

請在一個檔案中定義 i18n 設定。本指南會以 `@/lib/i18n` 匯入該設定。

```ts title="src/lib/i18n.ts"
import { defineI18n } from 'fumadocs-core/i18n';

export const i18n = defineI18n({
  defaultLanguage: 'en',
  languages: ['cn', 'en'],
});
```

> i18n 設定的可用選項請參閱[這裡](/docs/headless/internationalization/config)。

### 路由 [#routing]

為所有頁面加上 `[lang]` 前綴。

<Files>
<Folder name="src/pages" defaultOpen>
<Folder name="[lang]" defaultOpen>
<File name="(home)/_layout.tsx" />

<File name="(home)/index.tsx" />

<File name="docs/_layout.tsx" />

<File name="docs/[...slugs].tsx" />
</Folder>

<Folder name="_api" defaultOpen>
<File name="api/search.ts" />
</Folder>
</Folder>
</Files>

### 翻譯 [#translations]

請在 `lib/layout.shared.tsx` 中定義您的翻譯。詳細資訊 (包括官方語言包) 請參閱[翻譯](/docs/ui/translations)。

您也可以為 `baseOptions()` 加上 `locale` 參數，以提供依語系調整的版面配置選項：

```tsx title="src/lib/layout.shared.tsx"
// [!code ++:2]
import { i18n } from '@/lib/i18n';
import { uiTranslations } from 'fumadocs-ui/i18n';
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

// [!code ++:11]
export const translations = i18n
  .translations()
  .extend(uiTranslations())
  .add({
    en: {
      displayName: 'English',
    },
    cn: {
      displayName: 'Chinese',
    },
  });

export function baseOptions(): BaseLayoutProps { // [!code --]
export function baseOptions(locale: string): BaseLayoutProps { // [!code ++]
  return {
    nav: {
      title: 'My App',
      url: `/${locale}`, // [!code ++]
    },
  };
}
```

將翻譯傳入 `<RootProvider />`：

```tsx title="src/components/provider.tsx"
'use client';
import type { ReactNode } from 'react';
import { RootProvider } from 'fumadocs-ui/provider/waku';
// [!code ++:4]
import { i18nProvider } from 'fumadocs-ui/i18n';
import { useRouter } from 'waku/router/client';
import { i18n } from '@/lib/i18n';
import { translations } from '@/lib/layout.shared';

export function Provider({ children }: { children: ReactNode }) {
  // 路徑的第一個區段 [!code ++:2]
  const lang = useRouter().path.split('/')[1] || i18n.defaultLanguage;

  return <RootProvider>{children}</RootProvider>; // [!code --]
  return <RootProvider i18n={i18nProvider(translations, lang)}>{children}</RootProvider>; // [!code ++]
}
```

### 傳入語系 [#pass-locale]

請在頁面與版面配置中將語系傳給 Fumadocs。位於 `[lang]` 底下的版面配置與頁面會以 prop 的形式取得語系。

```ts tab="src/lib/source.ts"
import { i18n } from '@/lib/i18n'; // [!code ++]

export const source = loader({
  source: docs.toFumadocsSource(),
  baseUrl: '/docs',
  i18n, // [!code ++]
});
```

```tsx tab="首頁版面配置" title="src/pages/[lang]/(home)/_layout.tsx"
export default function Layout({ children }: { children: ReactNode }) { // [!code --]
export default function Layout({ lang, children }: { lang: string; children: ReactNode }) { // [!code ++]
  return <HomeLayout {...baseOptions()}>{children}</HomeLayout>; // [!code --]
  return <HomeLayout {...baseOptions(lang)}>{children}</HomeLayout>; // [!code ++]
}
```

```tsx tab="首頁" title="src/pages/[lang]/(home)/index.tsx"
import { i18n } from '@/lib/i18n'; // [!code ++]

// ...

export async function getConfig() {
  return {
    render: 'static',
    staticPaths: i18n.languages, // [!code ++]
  };
}
```

```tsx tab="文件版面配置" title="src/pages/[lang]/docs/_layout.tsx"
export default function Layout({ children }: { children: ReactNode }) { // [!code --]
export default function Layout({ lang, children }: { lang: string; children: ReactNode }) { // [!code ++]
  return (
    // [!code highlight]
    <DocsLayout {...baseOptions(lang)} tree={source.getPageTree(lang)}>
      {children}
    </DocsLayout>
  );
}
```

```tsx tab="文件頁面" title="src/pages/[lang]/docs/[...slugs].tsx"
export default function Page({ slugs }: PageProps<'/docs/[...slugs]'>) { // [!code --]
export default function Page({ lang, slugs }: PageProps<'/[lang]/docs/[...slugs]'>) { // [!code ++]
  const page = source.getPage(slugs); // [!code --]
  const page = source.getPage(slugs, lang); // [!code ++]
  if (!page) unstable_notFound();

  // ...
}

export async function getConfig() {
  const pages = source
    .generateParams()
    .map((item) => (item.lang ? [item.lang, ...item.slug] : item.slug)); // [!code highlight]

  return {
    render: 'static',
    staticPaths: pages,
  } as const;
}
```

### 搜尋 [#search]

請在您使用的搜尋方案中設定 i18n。

* **內建搜尋：** 請參閱[國際化](/docs/headless/search/orama#internationalization)。
* **雲端方案 (例如 Algolia) ：** 這類方案通常有官方的多語系支援。

## 撰寫文件 [#writing-documents]

請參閱 [i18n 路由](/docs/waku/page-conventions#i18n-routing)，了解如何為特定語系建立頁面。

### 導覽 [#navigation]

Fumadocs 只會處理其自身版面配置 (例如側邊欄) 中的導覽。

至於其他地方，請從路徑中擷取語系，並將其加在連結的開頭。

```tsx
import { Link, useRouter } from 'waku/router/client';

const router = useRouter();
const lang = router.path.split('/')[1];

<Link to={`/${lang}/about`}>About Us</Link>;
```

[`fumadocs-core/dynamic-link`](/docs/headless/components/link#dynamic-hrefs) 元件支援動態 href，因此您可以在 Markdown/MDX 內容中用它加上語系前綴。

```mdx title="content.mdx"
import { DynamicLink } from 'fumadocs-core/dynamic-link';

<DynamicLink href="/[lang]/another-page">This is a link</DynamicLink>
```