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

Support multiple languages in your TanStack Start docs.

<Callout title="Fumadocs CLI">
`npx @fumadocs/cli init --i18n` sets up a new docs with i18n, or configure it manually below.
</Callout>

## Overview [#overview]

Configure i18n routing on both TanStack Start and Fumadocs.

Fumadocs handles i18n for the docs content and sidebar. Internationalize the rest of your app with your own i18n setup.

## Setup [#setup]

Define the i18n config in a file. This guide imports it as `@/lib/i18n`.

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

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

> See [available options](/docs/headless/internationalization/config) for i18n config.

### Routing [#routing]

Create a `$lang` directory under `routes`, and move all pages into it.

<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 [#translations]

Define your translations in `lib/layout.shared.tsx`. See [Translations](/docs/ui/translations) for more details, including the official language packs.

You can also add a `locale` parameter to `baseOptions()` for localized layout options:

```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 {
    // different props based on `locale`
  };
}
```

Pass translations to `<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 [#pass-locale]

Pass the locale to Fumadocs in your pages and layouts.

```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="Home Page" 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="Docs Page" 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 [#search]

Configure i18n on your search solution.

- **Built-in Search:** See [Internationalization](/docs/headless/search/orama#internationalization).
- **Cloud Solutions (e.g. Algolia):** They usually have official support for multilingual.

## Writing Documents [#writing-documents]

See [i18n routing](/docs/tanstack-start/page-conventions#i18n-routing) to learn how to create pages for specific locales.

### Navigation [#navigation]

Fumadocs only handles navigation for its own layouts (e.g. sidebar).

For other places, use the `useParams` hook to get the locale from the URL.

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

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

<Link
  to="/$lang/docs/$"
  params={{
    lang,
    _splat: '',
  }}
>
  Open Docs
</Link>;
```

The [`fumadocs-core/dynamic-link`](/docs/headless/components/link#dynamic-hrefs) component supports dynamic hrefs, so you can use it to prepend the locale prefix in Markdown/MDX content.

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

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