{$content.title}
\n\n{@const Title = $content.title}
\n\n\n\n\n```\n\n### (Optional) Step 6: Change the language of your content\n\n```svelte fileName=\"src/App.svelte\"\n\n\n{$content.markdownContent}
\n```\n\n> You can also access your markdown front-matter data using the `content.markdownContent.metadata.xxx` property.\n\n### (Optional) Sitemap and robots.txt (build-time)\n\nIntlayer includes formatters such as `generateSitemap` and `getMultilingualUrls` that produce crawler-ready multilingual `sitemap.xml` and `robots.txt` output you can write into your project’s `public/` folder. In practice you run a small Node script **before** Vite (for example `predev` / `prebuild` npm hooks) so those files exist when you build or serve the app.\n\n#### Sitemap\n\nIntlayer’s sitemap generator respects your locale setup and includes the usual metadata for crawlers.\n\n> The generated sitemap supports the `xhtml:link` namespace (hreflang XML extensions). Unlike basic generators that only emit flat URLs, Intlayer wires bidirectional links between every localized variant of each page (for example `/about`, `/fr/about`, or `/about?lang=fr`, depending on your routing mode), which helps search engines relate localized URLs.\n\n#### Robots.txt\n\nUse `getMultilingualUrls` so `Disallow` entries cover every localized spelling of sensitive paths.\n\n#### 1. Add `generate-seo.mjs` at the project root\n\n```javascript fileName=\"generate-seo.mjs\"\nimport fs from \"fs\";\nimport path from \"path\";\nimport { fileURLToPath } from \"url\";\nimport { generateSitemap, getMultilingualUrls } from \"intlayer\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nconst SITE_URL = (process.env.SITE_URL || \"http://localhost:5173\").replace(\n /\\/$/,\n \"\"\n);\n\nconst pathList = [\n { path: \"/\", changefreq: \"daily\", priority: 1.0 },\n { path: \"/about\", changefreq: \"monthly\", priority: 0.7 },\n];\n\nconst sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });\nfs.writeFileSync(path.join(__dirname, \"public\", \"sitemap.xml\"), sitemapXml);\n\nconst getAllMultilingualUrls = (urls) =>\n urls.flatMap((url) => Object.values(getMultilingualUrls(url)));\n\nconst disallowedPaths = getAllMultilingualUrls([\"/admin\", \"/private\"]);\n\nconst robotsTxt = [\n \"User-agent: *\",\n \"Allow: /\",\n ...disallowedPaths.map((path) => `Disallow: ${path}`),\n \"\",\n `Sitemap: ${SITE_URL}/sitemap.xml`,\n].join(\"\\n\");\n\nfs.writeFileSync(path.join(__dirname, \"public\", \"robots.txt\"), robotsTxt);\n\nconsole.log(\"SEO files generated successfully.\");\n```\n\n`intlayer` must be installed so the script can import it. Set `SITE_URL` in the environment for production (for example in CI).\n\n> Prefer `generate-seo.mjs` for Node ESM. If you use `generate-seo.js` instead, ensure `\"type\": \"module\"` is set in `package.json`, or run Node with ESM enabled.\n\n#### 2. Run the script before Vite\n\n```json fileName=\"package.json\"\n{\n \"scripts\": {\n \"dev\": \"vite\",\n \"prebuild\": \"node generate-seo.mjs\",\n \"build\": \"vite build\",\n \"preview\": \"vite preview\"\n }\n}\n```\n\nAdjust if you use pnpm or yarn. You can also invoke the same script from CI or another step if that fits your workflow.\n\n### (Optional) Step 8: Set up the intlayer editor / CMS\n\nTo set up the intlayer editor, you must follow the [intlayer editor documentation](/en-GB/doc/concept/editor).\n\nTo set up the intlayer CMS, you must follow the [intlayer CMS documentation](/en-GB/doc/concept/cms).\n\n### (Optional) Step 7: Add localised Routing to your application\n\nTo handle localised routing in your Svelte application, you can use `svelte-spa-router` along with Intlayer's `localeFlatMap` to generate routes for each locale.\n\nFirst, install `svelte-spa-router`:\n\n```bash packageManager=\"npm\"\nnpm install svelte-spa-router\nnpx intlayer init\n```\n\n```bash packageManager=\"pnpm\"\npnpm add svelte-spa-router\npnpm intlayer init\n```\n\n```bash packageManager=\"yarn\"\nyarn add svelte-spa-router\nyarn intlayer init\n```\n\n```bash packageManager=\"bun\"\nbun add svelte-spa-router\n```\n\nThen, create a `Router.svelte` file to define your routes:\n\n```svelte fileName=\"src/Router.svelte\"\n\n\nAsk your question and get a summary of the document by referencing this page and the AI provider of your choice
Version History
- "Update Solid useIntlayer API usage to direct property access"v8.9.004/05/2026
- "Add init command"v7.5.930/12/2025
- "Update documentation"v5.5.1119/11/2025
- "Initial history"v5.5.1029/06/2025
The content of this page was translated using an AI.
See the last version of the original content in EnglishIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Translate your Vite and Svelte website using Intlayer | Internationalisation (i18n)
Table of Contents
What is Intlayer?
Intlayer is an innovative, open-source internationalisation (i18n) library designed to simplify multilingual support in modern web applications.
With Intlayer, you can:
- Easily manage translations using declarative dictionaries at the component level.
- Dynamically localise metadata, routes, and content.
- Ensure TypeScript support with autogenerated types, improving autocompletion and error detection.
- Benefit from advanced features, like dynamic locale detection and switching.
Step-by-Step Guide to Set Up Intlayer in a Vite and Svelte Application
See Application Template on GitHub.
Step 1: Install Dependencies
Install the necessary packages using npm:
Copy the code to the clipboard
npm install intlayer svelte-intlayernpm install vite-intlayer --save-devnpx intlayer initintlayer
The core package that provides internationalisation tools for configuration management, translation, content declaration, transpilation, and CLI commands.
svelte-intlayer The package that integrates Intlayer with Svelte applications. It provides context providers and hooks for Svelte internationalisation.
vite-intlayer Includes the Vite plugin for integrating Intlayer with the Vite bundler, as well as middleware for detecting the user's preferred locale, managing cookies, and handling URL redirection.
Step 2: Configuration of your project
Create a config file to configure the languages of your application:
Copy the code to the clipboard
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // Your other locales ], defaultLocale: Locales.ENGLISH, },};export default config;Through this configuration file, you can set up localised URLs, middleware redirection, cookie names, the location and extension of your content declarations, disable Intlayer logs in the console, and more. For a complete list of available parameters, refer to the configuration documentation.
Step 3: Integrate Intlayer in Your Vite Configuration
Add the intlayer plugin into your configuration.
Copy the code to the clipboard
import { defineConfig } from "vite";import { svelte } from "@sveltejs/vite-plugin-svelte";import { intlayer } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [svelte(), intlayer()],});The intlayer() Vite plugin is used to integrate Intlayer with Vite. It ensures the building of content declaration files and monitors them in development mode. It defines Intlayer environment variables within the Vite application. Additionally, it provides aliases to optimise performance.
Step 4: Declare Your Content
Create and manage your content declarations to store translations:
Copy the code to the clipboard
import { t, type Dictionary } from "intlayer";
const appContent = {
key: "app",
content: {
title: t({
en: "Hello World",
fr: "Bonjour le monde",
es: "Hola mundo",
}),
},
} satisfies Dictionary;
export default appContent;Your content declarations can be defined anywhere in your application as soon as they are included in thecontentDirdirectory (by default,./src). And match the content declaration file extension (by default,.content.{json,ts,tsx,js,jsx,mjs,cjs}).
For more details, refer to the content declaration documentation.
Step 5: Utilise Intlayer in Your Code
Copy the code to the clipboard
<script> import { useIntlayer } from "svelte-intlayer"; const content = useIntlayer("app");</script><div><!-- 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>(Optional) Step 6: Change the language of your content
Copy the code to the clipboard
<script lang="ts">import { getLocaleName } from 'intlayer';import { useLocale } from "svelte-intlayer";// Get locale information and setLocale functionconst { locale, availableLocales, setLocale } = useLocale();// Handle locale changeconst changeLocale = (event: Event) => { const target = event.target as HTMLSelectElement; const newLocale = target.value; setLocale(newLocale);};</script><div> <select value={$locale} on:change={changeLocale}> {#each availableLocales ?? [] as loc} <option value={loc}> {getLocaleName(loc)} </option> {/each} </select></div>(Optional) Step 7: Render Markdown
Intlayer supports rendering Markdown content directly in your Svelte application. By default, Markdown is treated as plain text. To convert Markdown into rich HTML, you can integrate @humanspeak/svelte-markdown, or another markdown parser.
To see how to declare markdown content using the intlayer package, see the markdown doc.
Copy the code to the clipboard
<script> import { setIntlayerMarkdown } from "svelte-intlayer"; setIntlayerMarkdown((markdown) => // render the markdown content as a string return markdown; );</script><h1>{$content.markdownContent}</h1>You can also access your markdown front-matter data using the content.markdownContent.metadata.xxx property.
(Optional) Sitemap and robots.txt (build-time)
Intlayer includes formatters such as generateSitemap and getMultilingualUrls that produce crawler-ready multilingual sitemap.xml and robots.txt output you can write into your project’s public/ folder. In practice you run a small Node script before Vite (for example predev / prebuild npm hooks) so those files exist when you build or serve the app.
Sitemap
Intlayer’s sitemap generator respects your locale setup and includes the usual metadata for crawlers.
The generated sitemap supports thexhtml:linknamespace (hreflang XML extensions). Unlike basic generators that only emit flat URLs, Intlayer wires bidirectional links between every localized variant of each page (for example/about,/fr/about, or/about?lang=fr, depending on your routing mode), which helps search engines relate localized URLs.
Robots.txt
Use getMultilingualUrls so Disallow entries cover every localized spelling of sensitive paths.
1. Add generate-seo.mjs at the project root
Copy the code to the clipboard
import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace( /\/$/, "");const pathList = [ { path: "/", changefreq: "daily", priority: 1.0 }, { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [ "User-agent: *", "Allow: /", ...disallowedPaths.map((path) => `Disallow: ${path}`), "", `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");intlayer must be installed so the script can import it. Set SITE_URL in the environment for production (for example in CI).
Prefergenerate-seo.mjsfor Node ESM. If you usegenerate-seo.jsinstead, ensure"type": "module"is set inpackage.json, or run Node with ESM enabled.
2. Run the script before Vite
Copy the code to the clipboard
{ "scripts": { "dev": "vite", "prebuild": "node generate-seo.mjs", "build": "vite build", "preview": "vite preview" }}Adjust if you use pnpm or yarn. You can also invoke the same script from CI or another step if that fits your workflow.
(Optional) Step 8: Set up the intlayer editor / CMS
To set up the intlayer editor, you must follow the intlayer editor documentation.
To set up the intlayer CMS, you must follow the intlayer CMS documentation.
(Optional) Step 7: Add localised Routing to your application
To handle localised routing in your Svelte application, you can use svelte-spa-router along with Intlayer's localeFlatMap to generate routes for each locale.
First, install svelte-spa-router:
Copy the code to the clipboard
npm install svelte-spa-routernpx intlayer initThen, create a Router.svelte file to define your routes:
Copy the code to the clipboard
<script lang="ts">import { localeFlatMap } from "intlayer";import Router from "svelte-spa-router";import { wrap } from "svelte-spa-router/wrap";import App from "./App.svelte";const routes = Object.fromEntries( localeFlatMap(({locale, urlPrefix}) => [ [ urlPrefix || '/', wrap({ component: App as any, props: { locale, }, }), ], ]));</script><Router {routes} />Update your main.ts to mount the Router component instead of App:
Copy the code to the clipboard
import { mount } from "svelte";import Router from "./Router.svelte";const app = mount(Router, { target: document.getElementById("app")!,});export default app;Finally, update your App.svelte to receive the locale prop and use it with useIntlayer:
Copy the code to the clipboard
<script lang="ts">import type { Locale } from 'intlayer';import { useIntlayer } from "svelte-intlayer";import Counter from './lib/Counter.svelte';import LocaleSwitcher from './lib/LocaleSwitcher.svelte';export let locale: Locale;$: content = useIntlayer('app', locale);</script><main> <div class="locale-switcher-container"> <LocaleSwitcher currentLocale={locale} /> </div> <!-- ... rest of your app ... --></main>Configure Server-Side Routing (Optional)
In parallel, you can also use the intlayerProxy to add server-side routing to your application. This plugin will automatically detect the current locale based on the URL and set the appropriate locale cookie. If no locale is specified, the plugin will determine the most appropriate locale based on the user's browser language preferences. If no locale is detected, it will redirect to the default locale.
Note that to use theintlayerProxyin production, you need to switch thevite-intlayerpackage fromdevDependenciestodependencies.
Copy the code to the clipboard
import { defineConfig } from "vite";
import { svelte } from "@sveltejs/vite-plugin-svelte";
import { intlayer, intlayerProxy } from "vite-intlayer";
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
intlayerProxy(), // should be placed first
svelte(),
intlayer(),
],
});(Optional) Step 8: Change the URL when the locale changes
To allow users to switch languages and update the URL accordingly, you can create a LocaleSwitcher component. This component will use getLocalizedUrl from intlayer and push from svelte-spa-router.
Copy the code to the clipboard
<script lang="ts">import { getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "svelte-intlayer";import { push } from "svelte-spa-router";export let currentLocale: string | undefined = undefined;// Get locale informationconst { locale, availableLocales } = useLocale();// Handle locale changeconst changeLocale = (event: Event) => { const target = event.target as HTMLSelectElement; const newLocale = target.value; const currentUrl = window.location.pathname; const url = getLocalizedUrl(currentUrl, newLocale); push(url);};</script><div class="locale-switcher"> <select value={currentLocale ?? $locale} onchange={changeLocale}> {#each availableLocales ?? [] as loc} <option value={loc}> {getLocaleName(loc)} </option> {/each} </select></div>Git Configuration
It is recommended to ignore the files generated by Intlayer. This prevents you from committing them to your Git repository.
To do this, you can add the following instructions to your .gitignore file:
Copy the code to the clipboard
# Ignore the files generated by Intlayer.intlayerVS Code Extension
To improve your development experience with Intlayer, you can install the official Intlayer VS Code Extension.
Install from the VS Code Marketplace
This extension provides:
- Autocompletion for translation keys.
- Real-time error detection for missing translations.
- Inline previews of translated content.
- Quick actions to easily create and update translations.
For more details on how to use the extension, refer to the Intlayer VS Code Extension documentation.
Go Further
To go further, you can implement the visual editor or externalise your content using the CMS.