國際化
讓您的 Waku 文件支援多種語言。
Fumadocs CLI
執行 npx @fumadocs/cli init --i18n 即可建立支援 i18n 的新文件網站，您也可以依照下方說明手動設定。
概覽
請在 Waku 與 Fumadocs 兩端設定 i18n 路由。
Fumadocs 會負責文件內容與側邊欄的 i18n。應用程式的其他部分，請透過您自己的 i18n 設定來進行國際化。
設定
請在一個檔案中定義 i18n 設定。本指南會以 @/lib/i18n 匯入該設定。
import { defineI18n } from 'fumadocs-core/i18n';
export const i18n = defineI18n({
defaultLanguage: 'en',
languages: ['cn', 'en'],
});i18n 設定的可用選項請參閱這裡。
路由
為所有頁面加上 [lang] 前綴。
(home)/_layout.tsx
(home)/index.tsx
docs/_layout.tsx
docs/[...slugs].tsx
api/search.ts
翻譯
請在 lib/layout.shared.tsx 中定義您的翻譯。詳細資訊 (包括官方語言包) 請參閱翻譯。
您也可以為 baseOptions() 加上 locale 參數，以提供依語系調整的版面配置選項：
import { i18n } from '@/lib/i18n';
import { uiTranslations } from 'fumadocs-ui/i18n';
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
export const translations = i18n
.translations()
.extend(uiTranslations())
.add({
en: {
displayName: 'English',
},
cn: {
displayName: 'Chinese',
},
});
export function baseOptions(): BaseLayoutProps {
export function baseOptions(locale: string): BaseLayoutProps {
return {
nav: {
title: 'My App',
url: `/${locale}`,
},
};
}將翻譯傳入 <RootProvider />：
'use client';
import type { ReactNode } from 'react';
import { RootProvider } from 'fumadocs-ui/provider/waku';
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 }) {
// 路徑的第一個區段
const lang = useRouter().path.split('/')[1] || i18n.defaultLanguage;
return <RootProvider>{children}</RootProvider>;
return <RootProvider i18n={i18nProvider(translations, lang)}>{children}</RootProvider>;
}傳入語系
請在頁面與版面配置中將語系傳給 Fumadocs。位於 [lang] 底下的版面配置與頁面會以 prop 的形式取得語系。
import { i18n } from '@/lib/i18n';
export const source = loader({
source: docs.toFumadocsSource(),
baseUrl: '/docs',
i18n,
});export default function Layout({ children }: { children: ReactNode }) {
export default function Layout({ lang, children }: { lang: string; children: ReactNode }) {
return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
return <HomeLayout {...baseOptions(lang)}>{children}</HomeLayout>;
}搜尋
請在您使用的搜尋方案中設定 i18n。
- 內建搜尋： 請參閱國際化。
- 雲端方案 (例如 Algolia) ： 這類方案通常有官方的多語系支援。
撰寫文件
請參閱 i18n 路由，了解如何為特定語系建立頁面。
導覽
Fumadocs 只會處理其自身版面配置 (例如側邊欄) 中的導覽。
至於其他地方，請從路徑中擷取語系，並將其加在連結的開頭。
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 元件支援動態 href，因此您可以在 Markdown/MDX 內容中用它加上語系前綴。
import { DynamicLink } from 'fumadocs-core/dynamic-link';
<DynamicLink href="/[lang]/another-page">This is a link</DynamicLink>How is this guide?
最後更新於
General Translation
Ferry Health
assistant-ui
Inkeep