@intlayer/docs 8.5.1 → 8.6.0

package/docs/en/intlayer_with_tanstack.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-09-09
-updatedAt: 2025-12-30
+updatedAt: 2026-03-29
 title: Tanstack Start i18n - How to translate an Tanstack Start app in 2026
 description: Learn how to add internationalization (i18n) to your Tanstack Start application using Intlayer. Follow this comprehensive guide to make your app multilingual with locale-aware routing.
 keywords:
@@ -12,6 +12,7 @@ keywords:
   - i18n
   - TypeScript
   - Locale Routing
+  - Sitemap
 slugs:
   - doc
   - environment
@@ -19,6 +20,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-tanstack-start-template
 youtubeVideo: https://www.youtube.com/watch?v=_XTdKVWaeqg
 history:
+  - version: 8.6.0
+    date: 2026-03-29
+    changes: "Add pre-render & sitemap"
   - version: 7.5.9
     date: 2025-12-30
     changes: "Add init command"
@@ -116,7 +120,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -160,14 +164,10 @@ import viteReact from "@vitejs/plugin-react";
 import { nitro } from "nitro/vite";
 import { defineConfig } from "vite";
 import { intlayer } from "vite-intlayer";
-import viteTsConfigPaths from "vite-tsconfig-paths";
 
 const config = defineConfig({
   plugins: [
     nitro(),
-    viteTsConfigPaths({
-      projects: ["./tsconfig.json"],
-    }),
     intlayer(),
     tanstackStart({
       router: {
@@ -593,15 +593,11 @@ import viteReact from "@vitejs/plugin-react";
 import { nitro } from "nitro/vite";
 import { defineConfig } from "vite";
 import { intlayer, intlayerProxy } from "vite-intlayer";
-import viteTsConfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
   plugins: [
     intlayerProxy(), // The proxy should be placed before server if you use Nitro
     nitro(),
-    viteTsConfigPaths({
-      projects: ["./tsconfig.json"],
-    }),
     intlayer(),
     tanstackStart({
       router: {
@@ -882,7 +878,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>
@@ -923,7 +919,82 @@ bun run build # Or bun run dev
 
 ---
 
-### Step 16: Configure TypeScript (Optional)
+### Step 16: Pre-render & Generate Sitemap (Optional)
+
+Intlayer comes with a built-in sitemap generator to help you create a sitemap for your application easily. It handles localized routes and adds the necessary metadata for search engines.
+
+> The Intlayer generated sitemap supports the `xhtml:link` namespace (Hreflang XML Extensions). Unlike the default sitemap generators that only list raw URLs, Intlayer automatically creates the required bidirectional links between all language versions of a page (e.g., `/about`, `/about?lang=fr`, and `/about?lang=es`). This ensures search engines correctly index and serve the right language version to the right audience.
+
+To use it, you first need to configure your `vite.config.ts` to enable pre-rendering for your localized routes and disable the default TanStack Start sitemap generation.
+
+```typescript fileName="vite.config.ts"
+import { localeFlatMap } from "intlayer";
+// ... other imports
+
+export const pathList = ["", "/about", "/404"];
+
+const localizedPages = localeFlatMap(({ urlPrefix }) =>
+  pathList.map((path) => ({
+    path: `${urlPrefix}${path}`,
+    prerender: {
+      enabled: true,
+    },
+  }))
+);
+
+export default defineConfig({
+  plugins: [
+    // ... other plugins
+    tanstackStart({
+      // ... other config
+      sitemap: {
+        enabled: false,
+      },
+      prerender: {
+        enabled: true,
+        crawlLinks: false,
+        concurrency: 10,
+      },
+      pages: localizedPages,
+    }),
+  ],
+});
+```
+
+Then, create a `src/routes/sitemap[.]xml.ts` route that uses the `generateSitemap` function:
+
+```typescript fileName="src/routes/sitemap[.]xml.ts"
+import { createFileRoute } from "@tanstack/react-router";
+import { generateSitemap } from "intlayer";
+
+const SITE_URL = (
+  import.meta.env.VITE_SITE_URL ?? "http://localhost:3000"
+).replace(/\/$/, "");
+
+export const Route = createFileRoute("/sitemap.xml")({
+  server: {
+    handlers: {
+      GET: async () => {
+        const sitemap = generateSitemap(
+          [
+            { path: "/", changefreq: "daily", priority: 1.0 },
+            { path: "/about", changefreq: "monthly", priority: 0.8 },
+          ],
+          { siteUrl: SITE_URL }
+        );
+
+        return new Response(sitemap, {
+          headers: { "Content-Type": "application/xml" },
+        });
+      },
+    },
+  },
+});
+```
+
+---
+
+### Step 17: Configure TypeScript (Optional)
 
 Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.
 

package/docs/en/intlayer_with_vite+lit.md

@@ -78,7 +78,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer lit-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -411,7 +411,6 @@ export class MyElement extends LitElement {
 }
 ```
 
-> [!NOTE]
 > When you need the translated string in a native HTML attribute (e.g. `alt`, `aria-label`, `title`), call `.value` on the leaf node:
 >
 > ```typescript

package/docs/en/intlayer_with_vite+preact.md

@@ -94,7 +94,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer preact-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -1464,7 +1464,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en/intlayer_with_vite+react.md

@@ -93,7 +93,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -1498,7 +1498,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en/intlayer_with_vite+react_compiler.md

@@ -102,7 +102,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en/intlayer_with_vite+solid.md

@@ -93,7 +93,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer solid-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -438,7 +438,6 @@ const App: Component = () => (
 export default App;
 ```
 
-> [!NOTE]
 > In Solid, `useIntlayer` returns an **accessor** function (e.g., `content()`). You must call this function to access the reactive content.
 
 > If you want to use your content in a `string` attribute, such as `alt`, `title`, `href`, `aria-label`, etc., you must call the value of the function, like:
@@ -770,7 +769,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en/intlayer_with_vite+svelte.md

@@ -83,7 +83,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer svelte-intlayer
 bun add vite-intlayer --save-dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -230,7 +230,7 @@ module.exports = appContent;
 <!-- Render content as simple content  -->
 <h1>{$content.title}</h1>
 <!-- To render the content editable using the editor -->
-<h1><svelte:component this={$content.title} /></h1>
+<h1>{@const Title = $content.title}<Title /></h1>
 <!-- To render the content as a string -->
 <div aria-label={$content.title.value}></div>
 ```
@@ -270,7 +270,7 @@ const changeLocale = (event: Event) => {
 
 Intlayer supports rendering Markdown and HTML content in Svelte.
 
-By default, Intlayer treats Markdown and HTML as interactive components or strings. To render them in Svelte, you can use the `<svelte:component this={...} />` for components or `{@html ...}` for plain strings.
+By default, Intlayer treats Markdown and HTML as interactive components or strings. To render them in Svelte, you can use the `{@const Component = ...}<Component />` for components or `{@html ...}` for plain strings.
 
 ```svelte fileName="src/App.svelte"
 <script>
@@ -280,14 +280,13 @@ By default, Intlayer treats Markdown and HTML as interactive components or strin
 </script>
 
 <!-- Render Markdown as a Component -->
-<svelte:component this={$content.myMarkdownContent} />
+{@const MyMarkdownContent = $content.myMarkdownContent}<MyMarkdownContent />
 
 <!-- Render HTML Content -->
 {@html $content.myHtmlContent.toString()}
 
 <!-- Render with custom component overrides -->
-<svelte:component
-  this={$content.myMarkdownContent.use({
+{@const MyMarkdownContent = $content.myMarkdownContent.use({
     h1: (props) => {
       const h1 = document.createElement('h1');
       h1.style.color = 'red';
@@ -300,7 +299,7 @@ By default, Intlayer treats Markdown and HTML as interactive components or strin
        return div;
     }
   })}
-/>
+<MyMarkdownContent />
 ```
 
 > [!TIP]
@@ -637,7 +636,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en/intlayer_with_vite+vanilla.md

@@ -69,7 +69,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer vanilla-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -640,7 +640,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en/intlayer_with_vite+vue.md

@@ -95,7 +95,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer vue-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -1108,7 +1108,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/en-GB/intlayer_CMS.md

@@ -86,7 +86,7 @@ pnpm intlayer login
 ```
 
 ```bash packageManager="bun"
-bunx intlayer login
+bun x intlayer login
 ```
 
 This will open your default browser to complete the authentication process and receive the necessary credentials (Client ID and Client Secret) to use Intlayer services.

package/docs/en-GB/intlayer_with_adonisjs.md

@@ -72,7 +72,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer adonis-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Setup

package/docs/en-GB/intlayer_with_analog.md

@@ -73,7 +73,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer angular-intlayer vite-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_angular.md

@@ -88,7 +88,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer angular-intlayer
 bun add @angular-builders/custom-webpack --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_create_react_app.md

@@ -63,7 +63,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer react-scripts-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -114,7 +114,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer react-scripts-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_express.md

@@ -77,7 +77,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer express-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Setup

package/docs/en-GB/intlayer_with_fastify.md

@@ -76,7 +76,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer fastify-intlayer
-bunx intlayer init
+bun x intlayer init
 
 ```
 

package/docs/en-GB/intlayer_with_hono.md

@@ -75,7 +75,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer hono-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Setup

package/docs/en-GB/intlayer_with_lynx+react.md

@@ -63,7 +63,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer lynx-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 **Intlayer** is an **innovative, open-source internationalisation (i18n) library** that simplifies multilingual support in modern applications. It works in many JavaScript/TypeScript environments, **including Lynx** (via the `react-intlayer` package).
@@ -98,7 +98,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer lynx-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Packages

package/docs/en-GB/intlayer_with_nestjs.md

@@ -87,7 +87,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer express-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Configure tsconfig.json

package/docs/en-GB/intlayer_with_next-i18next.md

@@ -572,7 +572,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer @intlayer/sync-json-plugin --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 ```ts fileName="intlayer.config.ts"

package/docs/en-GB/intlayer_with_next-intl.md

@@ -408,7 +408,7 @@ pnpm add intlayer @intlayer/sync-json-plugin --save-dev
 
 ```bash packageManager="bun"
 bun add intlayer @intlayer/sync-json-plugin --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 Create the intlayer configuration file:

package/docs/en-GB/intlayer_with_nextjs_14.md

@@ -68,7 +68,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nextjs_15.md

@@ -71,7 +71,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nextjs_16.md

@@ -96,7 +96,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nextjs_compiler.md

@@ -103,7 +103,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
 bun add @intlayer/babel --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nextjs_no_locale_path.md

@@ -89,7 +89,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nextjs_page_router.md

@@ -65,7 +65,7 @@ yarn intlayer init
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_nuxt.md

@@ -92,7 +92,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer vue-intlayer
 bun add --dev nuxt-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_react_native+expo.md

@@ -66,7 +66,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add --dev react-native-intlayer
-bunx intlayer init
+bun x intlayer init
 ```
 
 ### Packages

package/docs/en-GB/intlayer_with_react_router_v7.md

@@ -83,7 +83,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -174,10 +174,9 @@ Add the intlayer plugin into your configuration:
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import { intlayer } from "vite-intlayer";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
-  plugins: [reactRouter(), tsconfigPaths(), intlayer()],
+  plugins: [reactRouter(), intlayer()],
 });
 ```
 
@@ -512,13 +511,12 @@ You can also use the `intlayerProxy` to add server-side routing to your applicat
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import { intlayer, intlayerProxy } from "vite-intlayer";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
   plugins: [
     intlayerProxy(), // should be placed first
     reactRouter(),
-    tsconfigPaths(),
+
     intlayer(),
   ],
 });

package/docs/en-GB/intlayer_with_react_router_v7_fs_routes.md

@@ -82,7 +82,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -173,10 +173,9 @@ Add the intlayer plugin into your configuration:
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import { intlayer } from "vite-intlayer";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
-  plugins: [reactRouter(), tsconfigPaths(), intlayer()],
+  plugins: [reactRouter(), intlayer()],
 });
 ```
 
@@ -457,13 +456,12 @@ You can also use the `intlayerProxy` to add server-side routing to your applicat
 import { reactRouter } from "@react-router/dev/vite";
 import { defineConfig } from "vite";
 import { intlayer, intlayerProxy } from "vite-intlayer";
-import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
   plugins: [
     intlayerProxy(), // should be placed first
     reactRouter(),
-    tsconfigPaths(),
+
     intlayer(),
   ],
 });

package/docs/en-GB/intlayer_with_svelte_kit.md

@@ -120,7 +120,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer svelte-intlayer
 bun add vite-intlayer --save-dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**: The core i18n package.
@@ -296,7 +296,7 @@ yarn intlayer init
 ```bash packageManager="bun"
 bun add intlayer svelte-intlayer
 bun add vite-intlayer --save-dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**: The core i18n package.
@@ -370,7 +370,7 @@ prefix to access its reactive value (e.g., `$content.title`).
 <!-- Render content as simple content  -->
 <h1>{$content.title}</h1>
 <!-- To render the content editable using the editor -->
-<h1><svelte:component this={$content.title} /></h1>
+<h1>{@const Title = $content.title}<Title /></h1>
 <!-- To render the content as a string -->
 <div aria-label={$content.title.value}></div>
 ```
@@ -728,7 +728,7 @@ To be able to visualise the intlayer editor selector, you will have to use the c
   <h1>{$content.title}</h1>
 
   <!-- Render content as a component (required by the editor) -->
-  <svelte:component this={$content.component} />
+  {@const Component = $content.component}<Component />
 </div>
 ```