aymericzip/intlayer-skills / skills/intlayer-svelte
intlayer-svelte
VerifiedIntegrates Intlayer internationalization with Svelte and SvelteKit applications. Use when the user asks to "setup Svelte i18n", create a new translated component, use the "useIntlayer" store, or configure providers.
| File | Kind | Size |
|---|---|---|
| LICENCE.md | markdown | 10.7 KB |
| SKILL.md | skill md | 3.1 KB |
| references/compiler.md | markdown | 14.6 KB |
| references/concept_collections.md | markdown | 5.6 KB |
| references/concept_variants.md | markdown | 20.9 KB |
| references/environment_astro_svelte.md | markdown | 37.9 KB |
| references/environment_sveltekit.md | markdown | 36.2 KB |
| references/environment_vite-and-svelte.md | markdown | 38.6 KB |
| references/formatters.md | markdown | 17.3 KB |
| references/packages_intlayer_exports.md | markdown | 12.4 KB |
| references/packages_svelte-intlayer_exports.md | markdown | 4.4 KB |
| references/packages_svelte-intlayer_usePathname.md | markdown | 3.1 KB |
| references/packages_svelte-intlayer_useRewriteURL.md | markdown | 1.9 KB |
references/environment_sveltekit.md
View on GitHub---
createdAt: 2025-11-20
updatedAt: 2026-09-27
priority: 9
title: "SvelteKit i18n - Complete guide to translate your app"
description: "Set up Intlayer in SvelteKit: locale routing with hooks, translated content in load functions and components, hreflang and sitemap."
keywords:
- Internationalization
- Documentation
- Intlayer
- SvelteKit
- JavaScript
- SSR
slugs:
- doc
- environment
- sveltekit
applicationTemplate: https://github.com/aymericzip/intlayer-sveltekit-template
applicationShowcase: https://intlayer-sveltekit-template.vercel.app
history:
- version: 8.9.0
date: 2026-05-04
changes: "Update Solid useIntlayer API usage to direct property access"
- version: 7.5.9
date: 2025-12-30
changes: "Add init command"
- version: 7.1.10
date: 2025-11-20
changes: "Initial history"
author: aymericzip
---
# Translate your SvelteKit website using Intlayer
<Tabs defaultTab="code">
<Tab label="Code" value="code">
<iframe
src="https://ide.intlayer.org/aymericzip/intlayer-sveltekit-template?file=intlayer.config.ts"
className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
title="Demo CodeSandbox - Cách quốc tế hóa ứng dụng của bạn bằng Intlayer"
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
loading="lazy"
/>
</Tab>
<Tab label="Demo" value="demo">
<iframe
src="https://intlayer-sveltekit-template.vercel.app"
className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
title="Demo - intlayer-sveltekit-template"
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
loading="lazy"
/>
</Tab>
</Tabs>
## Table of Contents
<TOC/>
## Why Intlayer over alternatives?
Compared to main solutions like `svelte-i18n` or `i18next`, Intlayer is a solution that comes with integrated optimizations such as:
<AccordionGroup>
<Accordion header="Full SvelteKit coverage">
Intlayer is optimized to work perfectly with SvelteKit by offering **multilingual routing**, **SSR support**, and all the features needed for scaling internationalization (i18n).
</Accordion>
<Accordion header="Bundle size">
Instead of loading massive JSON files into your pages, load only the necessary content. Intlayer helps **reduce your bundle and page sizes by up to 50%**.
</Accordion>
<Accordion header="Maintainability">
Scoping your application's content **facilitates maintenance** for large-scale applications. You can duplicate or delete a single feature folder without the mental burden of reviewing your entire content codebase. Additionally, Intlayer is **fully typed** to ensure your content's accuracy.
</Accordion>
<Accordion header="AI Agent">
Co-locating content **reduces the context needed** by Large Language Models (LLMs). Intlayer also comes with a suite of tools, such as a **CLI** to test for missing translations,**[LSP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)**, **[MCP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)**, and **[agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)**, to make the developer experience (DX) even smoother for AI agents.
- [LSP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)
- [MCP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)
- [agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)
</Accordion>
<Accordion header="Automation">
Use automation to translate in your CI/CD pipeline using the LLM of your choice at the cost of your AI provider. Intlayer also offers a **compiler** to automate content extraction, as well as a [web platform](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md) to help **translate in the background**.
- [web platform](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Accordion>
<Accordion header="Performance">
Connecting massive JSON files to components can lead to performance and reactivity issues. Intlayer optimizes your content loading at build time.
</Accordion>
<Accordion header="Scaling with none-dev">
More than just an i18n solution, Intlayer provides an **self-hosted [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)** and a **[full CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)** to help you manage your multilingual content in **real-time**, making collaboration with translators, copywriters, and other team members seamless. Content can be stored locally and/or remotely.
- [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [full CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Accordion>
</AccordionGroup>
## Step-by-Step Guide to Set Up Intlayer in a SvelteKit Application
See [Application Template](https://github.com/aymericzip/intlayer-sveltekit-template) on GitHub.
To get started, create a new SvelteKit project. Here is the final structure that we will make:
```bash
.
├── intlayer.config.ts
├── package.json
├── src
│ ├── app.d.ts
│ ├── app.html
│ ├── hooks.server.ts
│ ├── lib
│ │ ├── getLocale.ts
│ │ ├── LocaleSwitcher.svelte
│ │ └── LocalizedLink.svelte
│ ├── params
│ │ └── locale.ts
│ └── routes
│ ├── [[locale=locale]]
│ │ ├── +layout.svelte
│ │ ├── +layout.ts
│ │ ├── +page.svelte
│ │ ├── +page.ts
│ │ ├── about
│ │ │ ├── +page.svelte
│ │ │ ├── +page.ts
│ │ │ └── page.content.ts
│ │ ├── Counter.content.ts
│ │ ├── Counter.svelte
│ │ ├── Header.content.ts
│ │ ├── Header.svelte
│ │ ├── home.content.ts
│ │ └── layout.content.ts
│ ├── +layout.svelte
│ └── layout.css
├── static
│ ├── favicon.svg
│ └── robots.txt
├── svelte.config.js
├── tsconfig.json
└── vite.config.ts
```
<Steps>
<Step number={1} title="Install Dependencies">
Install the necessary packages using npm:
```bash packageManager="npm"
npx intlayer init --interactive
```
```bash packageManager="pnpm"
pnpm dlx intlayer init --interactive
```
```bash packageManager="yarn"
yarn dlx intlayer init --interactive
```
```bash packageManager="bun"
bunx intlayer init --interactive
```
> the `--interactive` flag is optional. Use `intlayer-cli init` if you're an AI agent.
> This command will detect your environment and install the required packages. For example:
```bash packageManager="npm"
npm install intlayer svelte-intlayer
npm install vite-intlayer --save-dev
```
```bash packageManager="pnpm"
pnpm add intlayer svelte-intlayer
pnpm add vite-intlayer --save-dev
```
```bash packageManager="yarn"
yarn add intlayer svelte-intlayer
yarn add vite-intlayer --save-dev
```
```bash packageManager="bun"
bun add intlayer svelte-intlayer
bun add vite-intlayer --save-dev
```
- **intlayer**: The core i18n package.
- **svelte-intlayer**: Provides context providers and stores for Svelte/SvelteKit.
- **vite-intlayer**: The Vite plugin to integrate content declarations with the build process.
</Step>
<Step number={2} title="Configuration of your project">
Create a config file in your project root:
```typescript fileName="intlayer.config.ts"
import { Locales, type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
internationalization: {
locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
defaultLocale: Locales.ENGLISH,
},
};
export default config;
```
</Step>
<Step number={3} title="Integrate Intlayer in Your Vite Configuration">
Update your `vite.config.ts` to include the Intlayer plugin. This plugin handles the transpilation of your content files.
```typescript fileName="vite.config.ts"
import { sveltekit } from "@sveltejs/kit/vite";
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
export default defineConfig({
plugins: [intlayer(), sveltekit()], // order matters, Intlayer should be placed before SvelteKit
});
```
</Step>
<Step number={4} title="Declare Your Content">
Create your content declaration files anywhere in your `src` folder (e.g., `src/lib/content` or alongside your components). These files define the translatable content for your application using the `t()` function for each locale.
```ts fileName="src/features/hero/hero.content.ts" contentDeclarationFormat=["typescript", "esm", "cjs"]
import { t, type Dictionary } from "intlayer";
const heroContent = {
key: "hero-section",
content: {
title: t({
en: "Welcome to SvelteKit",
fr: "Bienvenue sur SvelteKit",
es: "Bienvenido a SvelteKit",
}),
},
} satisfies Dictionary;
export default heroContent;
```
</Step>
<Step number={5} title="Utilize Intlayer in Your Components">
Now you can use the `useIntlayer` function in any Svelte component. It returns a reactive store that automatically updates when the locale changes. The function will automatically respect the current locale (both during SSR and client-side navigation).
> **Note:** `useIntlayer` returns a Svelte store, so you need to use the `$` prefix to access its reactive value (e.g., `$content.title`).
```svelte fileName="src/lib/components/Component.svelte"
<script lang="ts">
import { useIntlayer } from "svelte-intlayer";
// "hero-section" corresponds to the key defined in Step 4
const content = useIntlayer("hero-section");
</script>
<!-- Render content as simple content -->
<h1>{$content.title}</h1>
<!-- To render the content editable using the editor -->
<h1>{@const Title = $content.title}<Title /></h1>
<!-- To render the content as a string -->
<div aria-label={$content.title.value}></div>
<div aria-label={$content.title.toString()}></div>
<div aria-label={String($content.title)}></div>
```
</Step>
<Step number={6} title="Set up routing" isOptional={true}>
The following steps show how to set up locale-based routing in SvelteKit. This allows your URLs to include the locale prefix (e.g., `/en/about`, `/fr/about`) for better SEO and user experience.
```bash
.
└─── src
├── app.d.ts # Define the locale type
├── hooks.server.ts # Manage locale routing
├── lib
│ └── getLocale.ts # Check the locale from the header, cookies
├── params
│ └── locale.ts # Define the locale parameter
└── routes
├── [[locale=locale]] # Wrap in a route group to set the locale
│ ├── +layout.svelte # Local layout for the route
│ ├── +layout.ts
│ ├── +page.svelte
│ ├── +page.ts
│ └── about
│ ├── +page.svelte
│ └── +page.ts
└── +layout.svelte # Root layout for fonts and global styles
```
</Step>
<Step number={7} title="Handle Server-Side Locale Detection">
In SvelteKit, the server needs to know the user's locale to render the correct content during SSR. We use `hooks.server.ts` to detect the locale from the URL or cookies.
Create or modify `src/hooks.server.ts`:
```typescript fileName="src/hooks.server.ts"
import type { Handle } from "@sveltejs/kit";
import { getLocalizedUrl } from "intlayer";
import { getLocale } from "$lib/getLocale";
export const handle: Handle = async ({ event, resolve }) => {
const detectedLocale = getLocale(event);
// Check if the current path already starts with a locale (e.g. /fr, /en)
const pathname = event.url.pathname;
const targetPathname = getLocalizedUrl(pathname, detectedLocale);
// If NO locale is present in the URL (e.g. user visits "/"), redirect them
if (targetPathname !== pathname) {
return new Response(undefined, {
headers: { Location: targetPathname },
status: 307, // Temporary redirect
});
}
return resolve(event, {
transformPageChunk: ({ html }) => html.replace("%lang%", detectedLocale),
});
};
```
Then, create a helper to get the user's locale from the request event:
```typescript fileName="src/lib/getLocale.ts"
import {
configuration,
getLocaleFromStorage,
localeDetector,
type Locale,
} from "intlayer";
import type { RequestEvent } from "@sveltejs/kit";
/**
* Get the user's locale from the request event.
* This function is used in the `handle` hook in `src/hooks.server.ts`.
*
* It first tries to get the locale from the Intlayer storage (cookies or custom headers).
* If the locale is not found, it falls back to the browser's "Accept-Language" negotiation.
*
* @param event - The request event from SvelteKit
* @returns The user's locale
*/
export const getLocale = (event: RequestEvent): Locale => {
const defaultLocale = configuration?.internationalization?.defaultLocale;
// Try to get locale from Intlayer storage (Cookies or headers)
const storedLocale = getLocaleFromStorage({
// SvelteKit cookies access
getCookie: (name: string) => event.cookies.get(name) ?? null,
// SvelteKit headers access
getHeader: (name: string) => event.request.headers.get(name) ?? null,
});
if (storedLocale) {
return storedLocale;
}
// Fallback to Browser "Accept-Language" negotiation
const negotiatorHeaders: Record<string, string> = {};
// Convert SvelteKit Headers object to a plain Record<string, string>
event.request.headers.forEach((value, key) => {
negotiatorHeaders[key] = value;
});
// Check the locale from the `Accept-Language` header
const userFallbackLocale = localeDetector(negotiatorHeaders);
if (userFallbackLocale) {
return userFallbackLocale;
}
// Return default locale if no match is found
return defaultLocale;
};
```
> `getLocaleFromStorage` will check the locale from header or cookie depending on your configuration. See [Configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md) for more details.
- [Configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
> The `localeDetector` function will treat the `Accept-Language` header and return the best match.
If the locale is not configured, we want to return a 404 error. To make it easier, we can create a `match` function to check if the locale is valid:
```ts fileName="/src/params/locale.ts"import { defaultLocale, locales, type Locale } from "intlayer";
export const match = (param: Locale = defaultLocale): boolean =>
locales.includes(param);
```
> **Note:** Ensure your `src/app.d.ts` includes the locale definition:
>
> ```typescript
> declare global {
> namespace App {
> interface Locals {
> locale: import("intlayer").Locale;
> }
> }
> }
> ```
For the `+layout.svelte` file, we can remove everything, to keep only static content, not related to i18n:
```svelte fileName="src/+layout.svelte"
<script lang="ts">
import './layout.css';
let { children } = $props();
</script>
<div class="app">
{@render children()}
</div>
<style>
.app {
/* */
}
</style>
```
Then, create a new page and layout under the `[[locale=locale]]` group:
```ts fileName="src/routes/[[locale=locale]]/+layout.ts"
import type { Load } from "@sveltejs/kit";
import { defaultLocale, type Locale } from "intlayer";
export const prerender = true;
// Use the generic Load type
export const load: Load = ({ params }) => {
const locale: Locale = (params.locale as Locale) ?? defaultLocale;
return {
locale,
};
};
```
```svelte fileName="src/routes/[[locale=locale]]/+layout.svelte"
<script lang="ts">
import type { Snippet } from 'svelte';
import { useIntlayer, setupIntlayer } from "svelte-intlayer";
import Header from './Header.svelte';
import type { LayoutData } from './$types';
let { children, data }: { children: Snippet, data: LayoutData } = $props();
// Initialize Intlayer with the locale from the route
$effect(() => {
setupIntlayer(data.locale);
});
// Use the layout content dictionary
const layoutContent = useIntlayer('layout');
</script>
<Header />
<main>
{@render children()}
</main>
<footer>
<p>
{$layoutContent.footer.prefix.value}{' '}
<a href="https://svelte.dev/docs/kit">{$layoutContent.footer.linkLabel.value}</a>{' '}
{$layoutContent.footer.suffix.value}
</p>
</footer>
<style>
/* */
</style>
```
```ts fileName="src/routes/[[locale=locale]]/+page.ts"
export const prerender = true;
```
```svelte fileName="src/routes/[[locale=locale]]/+page.svelte"
<script lang="ts">
import { useIntlayer } from "svelte-intlayer";
// Use the home content dictionary
const homeContent = useIntlayer('home');
</script>
<svelte:head>
<title>{$homeContent.title.value}</title>
</svelte:head>
<section>
<h1>
{$homeContent.title}
</h1>
</section>
<style>
/* */
</style>
```
</Step>
<Step number={8} title="Internationalized Links" isOptional={true}>
For SEO, it is recommended to prefix your routes with the locale (e.g., `/en/about`, `/fr/about`). This component automatically prefixes any link with the current locale.
```svelte fileName="src/lib/components/LocalizedLink.svelte"
<script lang="ts">
import { getLocalizedUrl } from "intlayer";
import { useLocale } from "svelte-intlayer";
let { href = "" } = $props();
const { locale } = useLocale();
// Helper to prefix URL with current locale
$: localizedHref = getLocalizedUrl(href, $locale);
</script>
<a href={localizedHref}>
<slot />
</a>
```
If you use `goto` from SvelteKit, you can use the same logic with `getLocalizedUrl` to navigate to the localized URL:
```typescript
import { goto } from "$app/navigation";
import { getLocalizedUrl } from "intlayer";
import { useLocale } from "svelte-intlayer";
const { locale } = useLocale();
const localizedPath = getLocalizedUrl("/about", $locale);
goto(localizedPath); // Navigates to /en/about or /fr/about depending on locale
```
</Step>
<Step number={9} title="Language Switcher" isOptional={true}>
To allow users to switch languages, update the URL.
```svelte fileName="src/lib/components/LanguageSwitcher.svelte"
<script lang="ts">
import { getLocalizedUrl, getLocaleName } from 'intlayer';
import { useLocale } from "svelte-intlayer";
import { page } from '$app/stores';
import { goto } from '$app/navigation';
const { locale, setLocale, availableLocales } = useLocale({
onLocaleChange: (newLocale) => {
const localizedPath = getLocalizedUrl($page.url.pathname, newLocale);
goto(localizedPath);
},
});
</script>
<ul class="locale-list">
{#each availableLocales as localeEl}
<li>
<a
href={getLocalizedUrl($page.url.pathname, localeEl)}
onclick={(e) => {
e.preventDefault();
setLocale(localeEl); // Will set the locale in the store and trigger onLocaleChange
}}
class:active={$locale === localeEl}
>
{getLocaleName(localeEl)}
</a>
</li>
{/each}
</ul>
<style>
/* */
</style>
```
</Step>
<Step number={10} title="Add backend proxy" isOptional={true}>
To add a backend proxy to your SvelteKit application, you can use the `intlayerProxy` function provided by the `vite-intlayer` plugin. This plugin will automatically detect the best locale for the user based on the URL, cookies, and browser language preferences.
> Since Intlayer v9, `intlayerProxy()` is bundled directly into the `intlayer()` plugin and enabled by default through the `routing.enableProxy` option (`true` by default). Registering it separately as shown below is now optional. It is kept for backward compatibility and for setups that need to control plugin order. Set `routing.enableProxy: false` to opt out. See the [v9 release notes](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/releases/v9.md).
- [v9 release notes](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/releases/v9.md)
```ts fileName="vite.config.ts"
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
import { sveltekit } from "@sveltejs/kit/vite";
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
intlayer({
proxy: {
ignore: (req) => req.url?.startsWith("/api"),
},
}),
sveltekit(),
],
});
```
</Step>
<Step number={11} title="Set up the intlayer editor / CMS" isOptional={true}>
To set up the intlayer editor, you must follow the [intlayer editor documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md).
- [intlayer editor documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
To set up the intlayer CMS, you must follow the [intlayer CMS documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md).
- [intlayer CMS documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
To be able to visualize the intlayer editor selector, you will have to use the component syntax in your intlayer content.
```svelte fileName="Component.svelte"
<script lang="ts">
import { useIntlayer } from "svelte-intlayer";
const content = useIntlayer("component");
</script>
<div>
<!-- Render content as simple content -->
<h1>{$content.title}</h1>
<!-- Render content as a component (required by the editor) -->
{@const Component = $content.component}<Component />
</div>
```
</Step>
<Step number={12} title="Extract the content of your components" isOptional={true}>
If you have an existing codebase, transforming thousands of files can be time-consuming.
To ease this process, Intlayer propose a [compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md) / [extractor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md) to transform your components and extract the content.
- [compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md)
- [extractor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md)
To set it up, you can add a `compiler` section in your `intlayer.config.ts` file:
```typescript fileName="intlayer.config.ts" codeFormat={["typescript", "esm", "commonjs"]}
import { type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
// ... Rest of your config
compiler: {
/**
* Indicates if the compiler should be enabled.
*/
enabled: true,
/**
* Defines the output files path
*/
output: ({ fileName, extension }) => `./${fileName}${extension}`,
/**
* Indicates if the components should be saved after being transformed.
*
* - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed.
*
* - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
*/
saveComponents: false,
/**
* Dictionary key prefix
*/
dictionaryKeyPrefix: "",
},
};
export default config;
```
<Tabs>
<Tab value='Extract command'>
Run the extractor to transform your components and extract the content
```bash packageManager="npm"
npx intlayer extract
```
```bash packageManager="pnpm"
pnpm intlayer extract
```
```bash packageManager="yarn"
yarn intlayer extract
```
```bash packageManager="bun"
bun x intlayer extract
```
</Tab>
<Tab value='Babel compiler'>
<Tabs>
<Tab value='intlayer >= 9'>
> Since v9, the `intlayerCompiler` is included in the `intlayer` plugin. So you don't need to add it manually.
</Tab>
<Tab value='intlayer < 9'>
Update your `vite.config.ts` to include the `intlayerCompiler` plugin:
```ts fileName="vite.config.ts"
import { defineConfig } from "vite";
import { intlayer, intlayerCompiler } from "vite-intlayer";
export default defineConfig({
plugins: [
intlayer(),
intlayerCompiler(), // Adds the compiler plugin
],
});
```
</Tab>
</Tabs>
Build your application to transform your components and extract the content
```bash packageManager="npm"
npm run build # Or npm run dev
```
```bash packageManager="pnpm"
pnpm run build # Or pnpm run dev
```
```bash packageManager="yarn"
yarn build # Or yarn dev
```
```bash packageManager="bun"
bun run build # Or bun run dev
```
</Tab>
</Tabs>
</Step>
</Steps>
### Git Configuration
It is recommended to ignore the files generated by Intlayer.
```plaintext fileName=".gitignore"
# Ignore the files generated by Intlayer
.intlayer
```
### Go Further
- [Intlayer Visual Editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
## Frequently Asked Questions
<FAQ>
<Question title="What are the different solutions available to internationalize a SvelteKit app?">
- **`svelte-i18n`** and **`typesafe-i18n`**: store based message catalogs, wired into the load functions by hand.
- **`Paraglide`**: compiled messages with a strong typing story, focused on the message layer only.
- **`Intlayer`**: the most advanced solution. Content declared anywhere in your codebase ([next to each component or centralized](https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/per-component_vs_centralized_i18n.md)) and compiled at build time, with locale aware routing, server side locale detection, AI translation, a visual editor and a CMS.
On SvelteKit the difference shows in the server side pieces: locale detection in hooks, localized links and the editor integration come with the library instead of being assembled per project. See [why Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/interest_of_intlayer.md) and the [Svelte i18n benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md).
- [why Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/interest_of_intlayer.md)
- [Svelte i18n benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md)
</Question>
<Question title="How much does i18n add to my SvelteKit bundle size?">
Much less than a namespace based setup, because a page never downloads a catalog it does not render. Server rendered markup resolves its content on the server, and the build time compiler replaces `useIntlayer` calls with the exact dictionary entries a component uses, so unused keys and unused languages are dropped, and [dynamic dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dynamic_dictionaries/index.md) split the rest per locale. Measured against the usual alternatives, Intlayer reduces bundle and page size by up to 50%. See [bundle optimization](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/bundle_optimization.md) and the [benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md).
- [dynamic dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dynamic_dictionaries/index.md)
- [bundle optimization](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/bundle_optimization.md)
- [benchmark](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md)
</Question>
<Question title="Can I migrate from `svelte-i18n` or `typesafe-i18n` without rewriting my components?">
Largely. Follow the [Svelte I18n migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compat/svelte-i18n.md) to move the content over. You can also migrate gradually: the [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md) keeps your existing JSON catalogs as the source of truth and generates Intlayer dictionaries from them, so both layers stay in sync while you move components across one at a time.
- [Svelte I18n migration guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compat/svelte-i18n.md)
- [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md)
</Question>
<Question title="Can I keep my existing JSON translation files?">
Yes. The [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md) keeps your `/messages/{locale}/{namespace}.json` files as the source of truth and generates Intlayer dictionaries from them, in both directions. A [sync PO plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-po.md) does the same for gettext catalogs, and [per locale files](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/per_locale_file.md) let you split content by language instead of grouping locales in one file.
- [sync JSON plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-json.md)
- [sync PO plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/plugins/sync-po.md)
- [per locale files](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/per_locale_file.md)
</Question>
<Question title="Do I have to move my content key by key?">
No. Run `npx intlayer extract` and Intlayer reads your components, pulls the user facing strings out and writes a `.content` file next to each one, so you review a diff instead of copying strings into a catalog one at a time. Step 12 of this guide walks through it.
For a fully automated pipeline, the [Intlayer Compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md) does the same at build time: it scans your JSX, TSX, Vue and Svelte source on every change, generates the dictionaries and keeps them in sync through hot module replacement, so there are no keys to maintain by hand at all.
- [Intlayer Compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/compiler.md)
Two limits are worth knowing before you turn the compiler on. It works by static analysis, so strings that only exist at runtime, such as API error codes or CMS fields, stay out of reach. And it has to tell user facing text apart from application logic like `className="active"` or a status code, which needs a few annotations in a large codebase. The [extract command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md) avoids both by keeping you in the loop.
- [extract command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/extract.md)
</Question>
<Question title="What editor and AI agent tooling is available?">
Five pieces, all optional:
- **[VS Code extension](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/vs_code_extension.md)**: jump from a `useIntlayer` key to the content file that declares it, extract content from a component, and run build, fill, test, push and pull from the command palette or a dedicated Intlayer tab.
- **[LSP server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/lsp.md)**: the same awareness in any editor that speaks LSP, with go to definition, find all references, hover previews of a translated value, autocompletion of keys and fields, and a warning when a key is not declared anywhere. It also resolves `i18next`, `react-i18next`, `next-intl` and `use-intl` calls, which helps while you migrate.
- **[MCP server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)**: exposes the Intlayer documentation and CLI to Cursor, VS Code, Claude Desktop, Claude Code and ChatGPT, so an assistant answers from current docs instead of guessing, and can run commands such as `intlayer fill` itself.
- **[Agent skills](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/agent_skills.md)**: focused skills such as `intlayer-config`, `intlayer-cli` and `intlayer-content`, plus one per framework, that teach an agent your routing setup and the content node types.
- **[ESLint plugin](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/eslint.md)**: `no-raw-text` flags hardcoded strings, with further rules for static dictionary keys and unused content.
</Question>
<Question title="Does Intlayer work with SvelteKit server side rendering and prerendering?">
Yes. Step 7 covers server side locale detection in `hooks.server.ts`, so the first HTML response already carries the right language, which is what search engines and social crawlers read. Prerendered routes resolve their content at build time.
</Question>
<Question title="How do I set up localized routes and internationalized links?">
Steps 6 and 8 cover it. A locale segment on the route tree plus `getLocalizedUrl` for links keeps navigation inside the active language, and `routing.mode` decides whether the default locale is prefixed at all. See the [configuration reference](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md).
- [configuration reference](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
</Question>
<Question title="How do I build a language switcher in Svelte?">
Step 9 shows the component. `useLocale` exposes the active locale, the declared locales and a setter that persists the choice in a cookie, while `getLocalizedUrl` rewrites the current path so the reader stays on the same page after switching.
</Question>
<Question title="How do I translate a SvelteKit app automatically with AI?">
Run `npx intlayer fill`, which fills missing translations with the LLM of your choice using your own provider and API key, and `--git-diff` restricts the run to the content changed on the branch. See the [fill command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/fill.md) and [CI/CD integration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/CI_CD.md).
- [fill command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/fill.md)
- [CI/CD integration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/CI_CD.md)
</Question>
<Question title="Does Intlayer support plurals, gender and rich text?">
Yes: [plural forms](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/plurial.md), [gender based content](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/gender.md), conditions, [insertions](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/insertion.md), [Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/markdown.md) and [formatters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/formatters.md) for numbers, dates and currencies.
- [plural forms](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/plurial.md)
- [gender based content](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/gender.md)
- [insertions](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/insertion.md)
- [Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/markdown.md)
- [formatters](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/formatters.md)
</Question>
<Question title="How can translators edit the content without touching the code?">
Through the [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md), which runs on your own infrastructure and lets anyone edit text in place on the running app, or the [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md), which externalizes content so it can change without a deployment.
- [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md)
- [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md)
</Question>
<Question title="Is Intlayer free and open source?">
Yes, under the Apache 2.0 license, commercial use included. The hosted CMS is an optional paid service that can also be [self hosted](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/self_hosting.md).
- [self hosted](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/self_hosting.md)
</Question>
</FAQ>
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |