Manage translations easily: Using declarative dictionaries at the component level.
Localise metadata, routes and content dynamically.
Ensure TypeScript support: With autogenerated types for better autocompletion and error detection.
Benefit from advanced features: Such as dynamic language detection and switching.

Step-by-Step Guide to Configure Intlayer in Astro

Check out the application template on GitHub.

Step 1: Install Dependencies

Install the necessary packages using your preferred package manager:

bash

Copy code

Copy the code to the clipboard

npm install intlayer astro-intlayer# Optional: If you add support for React islandsnpm install react react-dom react-intlayer @astrojs/react

intlayer The core package that provides i18n tools for configuration management, translations, content declaration, transpilation, and CLI commands.
astro-intlayer Includes the Astro integration plugin to link Intlayer with the Vite bundler, as well as the middleware to detect the user's preferred language, manage cookies, and handle URL redirects.

Step 2: Configure Your Project

Create a configuration file to define your application's languages:

intlayer.config.ts

Copy code

Copy the code to the clipboard

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      Locales.ENGLISH_UNITED_KINGDOM,      // Your other languages    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

Through this configuration file, you can configure localised URLs, middleware redirects, cookie names, location and extensions of content declarations, disable Intlayer logs in the console, and more. For a full list of available parameters, refer to the configuration documentation.

Step 3: Integrate Intlayer into Your Astro Configuration

Add the intlayer plugin to your Astro configuration.

astro.config.ts

Copy code

Copy the code to the clipboard

// @ts-checkimport { intlayer } from "astro-intlayer";import { defineConfig } from "astro/config";// https://astro.build/configexport default defineConfig({  integrations: [intlayer()],});

The intlayer() integration plugin is used to integrate Intlayer with Astro. It ensures the generation of the content declaration files and monitors them in development mode. It defines Intlayer environment variables within the Astro application and provides aliases to optimise performance.

Step 4: Declare Your Content

Create and manage your content declarations to store translations:

src/app.content.tsx

Copy code

Copy the code to the clipboard

import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    title: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola mundo",      "en-GB": "Hello World",    }),  },} satisfies Dictionary;export default appContent;

Content declarations can be defined anywhere in your application, as long as they are included in the contentDir (by default ./src) and match the content declaration file extension (by default .content.{json,ts,tsx,js,jsx,mjs,cjs}).

For more information, refer to the content declaration documentation.

Step 5: Using Content in Astro

You can consume the dictionaries directly in your .astro files using the core helpers exported from intlayer.

src/pages/index.astro

Copy code

Copy the code to the clipboard

---import {  getIntlayer,  getLocaleFromPath,  getLocalizedUrl,  defaultLocale,  localeMap,  getHTMLTextDir,  type LocalesValues,} from "intlayer";import LocaleSwitcher from "../components/LocaleSwitcher.astro";// Get the current locale from the URL (e.g. /es/about -> 'es')const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;// Get the content for the 'app' dictionaryconst { title } = getIntlayer("app", locale);---<!doctype html><html lang={locale} dir={getHTMLTextDir(locale)}>  <head>    <meta charset="utf-8" />    <meta name="viewport" content="width=device-width" />    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />    <title>{title}</title>    <!-- Canonical link: Tells search engines which is the primary version of this page -->    <link      rel="canonical"      href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)}    />    <!-- Hreflang: Tell Google about all localized versions -->    {      localeMap(({ locale: mapLocale }) => (        <link          rel="alternate"          hreflang={mapLocale}          href={new URL(            getLocalizedUrl(Astro.url.pathname, mapLocale),            Astro.site          )}        />      ))    }    <!-- x-default: Fallback for users in unmatched languages -->    <link      rel="alternate"      hreflang="x-default"      href={new URL(        getLocalizedUrl(Astro.url.pathname, defaultLocale),        Astro.site      )}    />  </head>  <body>    <header>      <LocaleSwitcher />    </header>    <main>      <h1>{title}</h1>    </main>  </body></html>

Step 6: Localised Routing

Create dynamic route segments to serve localised pages (e.g., src/pages/[locale]/index.astro):

src/pages/[locale]/index.astro

Copy code

Copy the code to the clipboard

---import { getIntlayer } from "intlayer";const { title } = getIntlayer('app');---<h1>{title}</h1>

The Astro integration adds a Vite middleware that helps with language-sensitive routing and environment definitions during development. You can also create links across languages using your own logic or intlayer tools like getLocalizedUrl.

Step 7: Continue Using Your Favourite Frameworks

Keep building your application using the framework of your choice.

Intlayer + React: Intlayer with React
Intlayer + Vue: Intlayer with Vue
Intlayer + Svelte: Intlayer with Svelte
Intlayer + Solid: Intlayer with Solid
Intlayer + Preact: Intlayer with Preact

TypeScript Configuration

Intlayer uses module augmentation to leverage TypeScript, making your codebase more robust.

Autocompletion

Translation Error

Ensure your TypeScript configuration includes the autogenerated types.

tsconfig.json

Copy code

Copy the code to the clipboard

{  // ... your existing TypeScript configuration  "include": [    // ... your existing TypeScript configuration    ".intlayer/**/*.ts", // Include autogenerated types  ],}

Git Configuration

It is recommended to ignore the files generated by Intlayer. This avoids committing them to your Git repository.

To do this, add the following instructions to your .gitignore file:

bash

Copy code

Copy the code to the clipboard

# Ignore the files generated by Intlayer.intlayer

VS Code Extension

To improve your development experience with Intlayer, you can install the official Intlayer VS Code extension.

Installation from the VS Code Marketplace

This extension provides:

Autocompletion for translation keys.
Real-time error detection for missing translations.
Inline preview of translated content.
Quick actions for easily creating and updating translations.

For more information on using the extension, refer to the VS Code Extension documentation.

(Optional) Step 15: Extract the content of your components

If you have an existing codebase, transforming thousands of files can be time-consuming.

To ease this process, Intlayer propose a compiler / extractor to transform your components and extract the content.

To set it up, you can add a compiler section in your intlayer.config.ts file:

intlayer.config.ts

Copy code

Copy the code to the clipboard

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;

Run the extractor to transform your components and extract the content

bash

Copy code

Copy the code to the clipboard

npx intlayer extract

Update your vite.config.ts to include the intlayerCompiler plugin:

vite.config.ts

Copy code

Copy the code to the clipboard

import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // Adds the compiler plugin ],});

bash

Copy code

Copy the code to the clipboard

npm run build # Or npm run dev

Deepen Your Knowledge

If you want to learn more, you can also implement the Visual Editor or use the CMS to externalise your content.

Tanstack Start Solid

Astro and React

Creation:2024-03-07Last update:2026-05-06

See the application template on GitHub

This page has an application template available.

See the showcase application

This page links to a live demo of the template.

Reference this doc to your favorite AI assistant

ChatGPT

Claude

DeepSeek

Google AI mode Gemini

Perplexity Mistral

Grok

Ask 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
"Added init command"
v7.5.930/12/2025
"Update of Astro integration, configuration and usage"
v6.2.003/10/2025

The content of this page was translated using an AI.

See the last version of the original content in English

Edit this doc

If you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.

GitHub link to the documentation

Copy

Copy doc Markdown to clipboard

Translate your Astro site with Intlayer | Internationalisation (i18n)

ide.intlayer.org

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:

Manage translations easily: Using declarative dictionaries at the component level.
Localise metadata, routes and content dynamically.
Ensure TypeScript support: With autogenerated types for better autocompletion and error detection.
Benefit from advanced features: Such as dynamic language detection and switching.

Step-by-Step Guide to Configure Intlayer in Astro

Check out the application template on GitHub.

Step 1: Install Dependencies

Install the necessary packages using your preferred package manager:

bash

Copy code

Copy the code to the clipboard

npm install intlayer astro-intlayer# Optional: If you add support for React islandsnpm install react react-dom react-intlayer @astrojs/react

npm install intlayer astro-intlayer# Optional: If you add support for React islandsnpm install react react-dom react-intlayer @astrojs/react

intlayer The core package that provides i18n tools for configuration management, translations, content declaration, transpilation, and CLI commands.
astro-intlayer Includes the Astro integration plugin to link Intlayer with the Vite bundler, as well as the middleware to detect the user's preferred language, manage cookies, and handle URL redirects.

Step 2: Configure Your Project

Create a configuration file to define your application's languages:

intlayer.config.ts

Copy code

Copy the code to the clipboard

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      Locales.ENGLISH_UNITED_KINGDOM,      // Your other languages    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      Locales.ENGLISH_UNITED_KINGDOM,      // Your other languages    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

Through this configuration file, you can configure localised URLs, middleware redirects, cookie names, location and extensions of content declarations, disable Intlayer logs in the console, and more. For a full list of available parameters, refer to the configuration documentation.

Step 3: Integrate Intlayer into Your Astro Configuration

Add the intlayer plugin to your Astro configuration.

astro.config.ts

Copy code

Copy the code to the clipboard

// @ts-checkimport { intlayer } from "astro-intlayer";import { defineConfig } from "astro/config";// https://astro.build/configexport default defineConfig({  integrations: [intlayer()],});

// @ts-checkimport { intlayer } from "astro-intlayer";import { defineConfig } from "astro/config";// https://astro.build/configexport default defineConfig({  integrations: [intlayer()],});

The intlayer() integration plugin is used to integrate Intlayer with Astro. It ensures the generation of the content declaration files and monitors them in development mode. It defines Intlayer environment variables within the Astro application and provides aliases to optimise performance.

Step 4: Declare Your Content

Create and manage your content declarations to store translations:

src/app.content.tsx

Copy code

Copy the code to the clipboard

import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    title: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola mundo",      "en-GB": "Hello World",    }),  },} satisfies Dictionary;export default appContent;

import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    title: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola mundo",      "en-GB": "Hello World",    }),  },} satisfies Dictionary;export default appContent;

Content declarations can be defined anywhere in your application, as long as they are included in the contentDir (by default ./src) and match the content declaration file extension (by default .content.{json,ts,tsx,js,jsx,mjs,cjs}).

For more information, refer to the content declaration documentation.

Step 5: Using Content in Astro

You can consume the dictionaries directly in your .astro files using the core helpers exported from intlayer.

src/pages/index.astro

Copy code

Copy the code to the clipboard

---import {  getIntlayer,  getLocaleFromPath,  getLocalizedUrl,  defaultLocale,  localeMap,  getHTMLTextDir,  type LocalesValues,} from "intlayer";import LocaleSwitcher from "../components/LocaleSwitcher.astro";// Get the current locale from the URL (e.g. /es/about -> 'es')const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;// Get the content for the 'app' dictionaryconst { title } = getIntlayer("app", locale);---<!doctype html><html lang={locale} dir={getHTMLTextDir(locale)}>  <head>    <meta charset="utf-8" />    <meta name="viewport" content="width=device-width" />    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />    <title>{title}</title>    <!-- Canonical link: Tells search engines which is the primary version of this page -->    <link      rel="canonical"      href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)}    />    <!-- Hreflang: Tell Google about all localized versions -->    {      localeMap(({ locale: mapLocale }) => (        <link          rel="alternate"          hreflang={mapLocale}          href={new URL(            getLocalizedUrl(Astro.url.pathname, mapLocale),            Astro.site          )}        />      ))    }    <!-- x-default: Fallback for users in unmatched languages -->    <link      rel="alternate"      hreflang="x-default"      href={new URL(        getLocalizedUrl(Astro.url.pathname, defaultLocale),        Astro.site      )}    />  </head>  <body>    <header>      <LocaleSwitcher />    </header>    <main>      <h1>{title}</h1>    </main>  </body></html>

---import {  getIntlayer,  getLocaleFromPath,  getLocalizedUrl,  defaultLocale,  localeMap,  getHTMLTextDir,  type LocalesValues,} from "intlayer";import LocaleSwitcher from "../components/LocaleSwitcher.astro";// Get the current locale from the URL (e.g. /es/about -> 'es')const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;// Get the content for the 'app' dictionaryconst { title } = getIntlayer("app", locale);---<!doctype html><html lang={locale} dir={getHTMLTextDir(locale)}>  <head>    <meta charset="utf-8" />    <meta name="viewport" content="width=device-width" />    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />    <title>{title}</title>    <!-- Canonical link: Tells search engines which is the primary version of this page -->    <link      rel="canonical"      href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)}    />    <!-- Hreflang: Tell Google about all localized versions -->    {      localeMap(({ locale: mapLocale }) => (        <link          rel="alternate"          hreflang={mapLocale}          href={new URL(            getLocalizedUrl(Astro.url.pathname, mapLocale),            Astro.site          )}        />      ))    }    <!-- x-default: Fallback for users in unmatched languages -->    <link      rel="alternate"      hreflang="x-default"      href={new URL(        getLocalizedUrl(Astro.url.pathname, defaultLocale),        Astro.site      )}    />  </head>  <body>    <header>      <LocaleSwitcher />    </header>    <main>      <h1>{title}</h1>    </main>  </body></html>

Step 6: Localised Routing

Create dynamic route segments to serve localised pages (e.g., src/pages/[locale]/index.astro):

src/pages/[locale]/index.astro

Copy code

Copy the code to the clipboard

---import { getIntlayer } from "intlayer";const { title } = getIntlayer('app');---<h1>{title}</h1>

---import { getIntlayer } from "intlayer";const { title } = getIntlayer('app');---<h1>{title}</h1>

Step 7: Continue Using Your Favourite Frameworks

Keep building your application using the framework of your choice.

Intlayer + React: Intlayer with React
Intlayer + Vue: Intlayer with Vue
Intlayer + Svelte: Intlayer with Svelte
Intlayer + Solid: Intlayer with Solid
Intlayer + Preact: Intlayer with Preact

TypeScript Configuration

Intlayer uses module augmentation to leverage TypeScript, making your codebase more robust.

Autocompletion

Translation Error

Ensure your TypeScript configuration includes the autogenerated types.

tsconfig.json

Copy code

Copy the code to the clipboard

{  // ... your existing TypeScript configuration  "include": [    // ... your existing TypeScript configuration    ".intlayer/**/*.ts", // Include autogenerated types  ],}

{  // ... your existing TypeScript configuration  "include": [    // ... your existing TypeScript configuration    ".intlayer/**/*.ts", // Include autogenerated types  ],}

Git Configuration

It is recommended to ignore the files generated by Intlayer. This avoids committing them to your Git repository.

To do this, add the following instructions to your .gitignore file:

bash

Copy code

Copy the code to the clipboard

# Ignore the files generated by Intlayer.intlayer

# Ignore the files generated by Intlayer.intlayer

VS Code Extension

To improve your development experience with Intlayer, you can install the official Intlayer VS Code extension.

Installation from the VS Code Marketplace

This extension provides:

Autocompletion for translation keys.
Real-time error detection for missing translations.
Inline preview of translated content.
Quick actions for easily creating and updating translations.

For more information on using the extension, refer to the VS Code Extension documentation.

(Optional) Step 15: Extract the content of your components

If you have an existing codebase, transforming thousands of files can be time-consuming.

To ease this process, Intlayer propose a compiler / extractor to transform your components and extract the content.

To set it up, you can add a compiler section in your intlayer.config.ts file:

intlayer.config.ts

Copy code

Copy the code to the clipboard

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;

Run the extractor to transform your components and extract the content

bash

Copy code

Copy the code to the clipboard

npx intlayer extract

npx intlayer extract

Update your vite.config.ts to include the intlayerCompiler plugin:

vite.config.ts

Copy code

Copy the code to the clipboard

import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // Adds the compiler plugin ],});

import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // Adds the compiler plugin ],});

bash

Copy code

Copy the code to the clipboard

npm run build # Or npm run dev

npm run build # Or npm run dev

Deepen Your Knowledge

If you want to learn more, you can also implement the Visual Editor or use the CMS to externalise your content.

Tanstack Start Solid

Astro and React

Version History

Translate your Astro site with Intlayer | Internationalisation (i18n)

Table of Contents

What is Intlayer?

Step-by-Step Guide to Configure Intlayer in Astro

Step 1: Install Dependencies

Step 2: Configure Your Project

Step 3: Integrate Intlayer into Your Astro Configuration

Step 4: Declare Your Content

Step 5: Using Content in Astro

Step 6: Localised Routing

Step 7: Continue Using Your Favourite Frameworks

TypeScript Configuration

Git Configuration

VS Code Extension

(Optional) Step 15: Extract the content of your components

Deepen Your Knowledge

Version History

Translate your Astro site with Intlayer | Internationalisation (i18n)

Table of Contents

What is Intlayer?

Step-by-Step Guide to Configure Intlayer in Astro

Step 1: Install Dependencies

Step 2: Configure Your Project

Step 3: Integrate Intlayer into Your Astro Configuration

Step 4: Declare Your Content

Step 5: Using Content in Astro

Step 6: Localised Routing

Step 7: Continue Using Your Favourite Frameworks

TypeScript Configuration

Git Configuration

VS Code Extension

(Optional) Step 15: Extract the content of your components

Deepen Your Knowledge