@intlayer/docs 8.5.1 → 8.6.0

package/docs/en-GB/intlayer_with_tanstack.md

@@ -116,7 +116,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 +160,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 +589,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: {
@@ -755,7 +747,80 @@ export const Route = createFileRoute("/{-$locale}/$")({
 
 ---
 
-### Step 16: Configure TypeScript (Optional)
+### Step 16: 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.
+
+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-GB/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-GB/intlayer_with_vite+preact.md

@@ -89,7 +89,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**

package/docs/en-GB/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**

package/docs/en-GB/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-GB/intlayer_with_vite+solid.md

@@ -97,7 +97,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**
@@ -312,7 +312,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:

package/docs/en-GB/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**
@@ -232,7 +232,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>
 ```

package/docs/en-GB/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-GB/intlayer_with_vite+vue.md

@@ -90,7 +90,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**

package/docs/es/intlayer_CMS.md

@@ -86,7 +86,7 @@ pnpm intlayer login
 ```
 
 ```bash packageManager="bun"
-bunx intlayer login
+bun x intlayer login
 ```
 
 Esto abrirá tu navegador predeterminado para completar el proceso de autenticación y recibir las credenciales necesarias (Client ID y Client Secret) para usar los servicios de Intlayer.

package/docs/es/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
 ```
 
 ### Configuración

package/docs/es/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/es/intlayer_with_angular.md

@@ -85,7 +85,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/es/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**

package/docs/es/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
 ```
 
 ### Configuración

package/docs/es/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/es/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
 ```
 
 ### Configuración

package/docs/es/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
 ```
 
 ### Paquetes

package/docs/es/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
 ```
 
 ### Configurar tsconfig.json

package/docs/es/intlayer_with_next-i18next.md

@@ -573,7 +573,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/es/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
 ```
 
 Crea el archivo de configuración de intlayer:

package/docs/es/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/es/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/es/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**
@@ -1848,7 +1848,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/es/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**
@@ -572,7 +572,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>

package/docs/es/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/es/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/es/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/es/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
 ```
 
 ### Paquetes

package/docs/es/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**
@@ -175,10 +175,9 @@ Agrega el plugin intlayer en tu configuración:
 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()],
 });
 ```
 
@@ -624,7 +623,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>
@@ -740,13 +739,12 @@ También puedes usar el `intlayerProxy` para agregar enrutamiento del lado del s
 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/es/intlayer_with_react_router_v7_fs_routes.md

@@ -98,7 +98,7 @@ pnpm add @react-router/fs-routes --save-dev
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
 bun add @react-router/fs-routes --dev
-bunx intlayer init
+bun x intlayer init
 ```
 
 - **intlayer**
@@ -170,10 +170,9 @@ Agrega el plugin intlayer en tu configuración:
 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()],
 });
 ```
 
@@ -693,7 +692,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>
@@ -744,13 +743,12 @@ También puedes usar el `intlayerProxy` para agregar enrutamiento del lado del s
 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/es/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**: El paquete principal de i18n.
@@ -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**: El paquete principal de i18n.
@@ -370,7 +370,7 @@ para acceder a su valor reactivo (por ejemplo, `$content.title`).
 <!-- Renderizar contenido como contenido simple  -->
 <h1>{$content.title}</h1>
 <!-- Para renderizar el contenido editable usando el editor -->
-<h1><svelte:component this={$content.title} /></h1>
+<h1>{@const Title = $content.title}<Title /></h1>
 <!-- Para renderizar el contenido como una cadena -->
 <div aria-label={$content.title.value}></div>
 ```
@@ -726,7 +726,7 @@ Para poder visualizar el selector del editor intlayer, deberás usar la sintaxis
   <h1>{$content.title}</h1>
 
   <!-- Renderizar contenido como un componente (requerido por el editor) -->
-  <svelte:component this={$content.component} />
+  {@const Component = $content.component}<Component />
 </div>
 ```
 
@@ -847,7 +847,7 @@ yarn intlayer extract
 ```
 
 ```bash packageManager="bun"
-bunx intlayer extract
+bun x intlayer extract
 ```
 
  </Tab>