Skip to content

docs: Update README for translated pathnames #6888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nlynzaad merged 1 commit into from
Mar 14, 2026
+15 −0
Merged

docs: Update README for translated pathnames #6888

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions examples/react/start-i18n-paraglide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ export const Route = createRootRoute({
If you don't want to miss any translated path, you can create a `createTranslatedPathnames` function and pass it to the vite plugin.

```ts
// i18n/lib.ts
import { Locale } from '@/paraglide/runtime'
import { FileRoutesByTo } from '../routeTree.gen'

Expand Down Expand Up @@ -190,6 +191,20 @@ export const translatedPathnames = createTranslatedPathnames({

And import into the Paraglide Vite plugin.

```ts
// vite.config.ts
import { translatedPathnames } from './i18n/lib'

export default defineConfig({
plugins: [
paraglideVitePlugin({
// ... other options
urlPatterns: translatedPathnames,
}),
],
})
```

## Prerender routes

You can use the `localizeHref` function to map the routes to localized versions and import into the pages option in the TanStack Start plugin. For this to work you will need to compile paraglide before the build with the CLI.
Expand Down
Loading