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

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

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

## 概覽 [#overview]

請在 TanStack Start 與 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]

在 `routes` 下建立 `$lang` 目錄，並將所有頁面移入其中。

<Files>
<Folder name="src/routes" defaultOpen>
<Folder name="$lang" defaultOpen>
<File name="index.tsx" />

<File name="docs/$.tsx" />
</Folder>

<Folder name="api" defaultOpen>
<File name="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 {
    // 根據 `locale` 回傳不同的 props
  };
}
```

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

```tsx title="src/routes/__root.tsx"
import { createRootRoute, HeadContent, Outlet, Scripts } from '@tanstack/react-router'; // [!code --]
import { createRootRoute, HeadContent, Outlet, Scripts, useParams } from '@tanstack/react-router'; // [!code ++]
import { RootProvider } from 'fumadocs-ui/provider/tanstack';
// [!code ++:3]
import { i18nProvider } from 'fumadocs-ui/i18n';
import { i18n } from '@/lib/i18n';
import { translations } from '@/lib/layout.shared';

// ...

function RootComponent() {
  const { lang = i18n.defaultLanguage } = useParams({ strict: false }); // [!code ++]

  return (
    // [!code highlight]
    <html lang={lang} suppressHydrationWarning>
      <head>
        <HeadContent />
      </head>
      <body className="flex flex-col min-h-screen">
        <RootProvider
          // [!code ++]
          i18n={i18nProvider(translations, lang)}
        >
          <Outlet />
        </RootProvider>
        <Scripts />
      </body>
    </html>
  );
}
```

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

請在頁面與版面配置中將語系傳給 Fumadocs。

```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/routes/$lang/index.tsx"
export const Route = createFileRoute('/')({ // [!code --]
export const Route = createFileRoute('/$lang/')({ // [!code ++]
  component: Home,
});

function Home() {
  const { lang } = Route.useParams(); // [!code ++]

  return (
    // [!code highlight]
    <HomeLayout {...baseOptions(lang)}>
      {/* ... */}
    </HomeLayout>
  );
}
```

```tsx tab="文件頁面" title="src/routes/$lang/docs/$.tsx"
export const Route = createFileRoute('/docs/$')({ // [!code --]
export const Route = createFileRoute('/$lang/docs/$')({ // [!code ++]
  component: Page,
  loader: async ({ params }) => {
    const slugs = params._splat?.split('/') ?? [];
    const data = await serverLoader({ data: slugs }); // [!code --]
    const data = await serverLoader({ data: { slugs, lang: params.lang } }); // [!code ++]
    await docs.getPage(data.path)?.preload();
    return data;
  },
});

const serverLoader = createServerFn({
  method: 'GET',
})
  .validator((slugs: string[]) => slugs) // [!code --]
  .handler(async ({ data: slugs }) => { // [!code --]
  .validator((data: { slugs: string[]; lang: string }) => data) // [!code ++]
  .handler(async ({ data: { slugs, lang } }) => { // [!code ++]
    const page = source.getPage(slugs); // [!code --]
    const page = source.getPage(slugs, lang); // [!code ++]
    if (!page) throw notFound();

    return {
      path: page.path,
      pageTree: await source.serializePageTree(source.getPageTree()), // [!code --]
      pageTree: await source.serializePageTree(source.getPageTree(lang)), // [!code ++]
    };
  });

function Page() {
  const { lang } = Route.useParams(); // [!code ++]
  const data = useFumadocsLoader(Route.useLoaderData());

  return (
    // [!code highlight]
    <DocsLayout {...baseOptions(lang)} tree={data.pageTree}>
      <Suspense>
        <Content path={data.path} />
      </Suspense>
    </DocsLayout>
  );
}
```

### 搜尋 [#search]

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

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

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

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

### 導覽 [#navigation]

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

至於其他地方，請使用 `useParams` hook 從 URL 取得語系。

```tsx
import { Link, useParams } from '@tanstack/react-router';

const { lang } = useParams({ from: '/$lang/' });

<Link
  to="/$lang/docs/$"
  params={{
    lang,
    _splat: '',
  }}
>
  Open Docs
</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>
```