@intlayer/docs 8.4.10 → 8.5.1

package/docs/en-GB/intlayer_with_vite+vue.md

@@ -429,14 +429,14 @@ To utilise Intlayer's internationalisation features throughout your Vue applicat
 
 ```javascript fileName=main.js
 import { createApp } from "vue";
-import { installIntlayer } from "vue-intlayer";
+import { intlayer } from "vue-intlayer";
 import App from "./App.vue";
 import "./style.css";
 
 const app = createApp(App);
 
 // Inject the provider at the top level
-installIntlayer(app);
+app.use(intlayer);
 
 // Mount the app
 app.mount("#app");
@@ -615,7 +615,7 @@ import {
   localeFlatMap,
   type Locale,
 } from 'intlayer';
-import { createIntlayerClient } from 'vue-intlayer';
+import { createIntlayerClient } from "vue-intlayer";
 import { createRouter, createWebHistory } from 'vue-router';
 import HomeView from './views/home/HomeView.vue';
 import RootView from './views/root/Root.vue';
@@ -703,7 +703,11 @@ import { intlayer, intlayerProxy } from "vite-intlayer";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -714,7 +718,11 @@ import { intlayer, intlayerProxy } from "vite-intlayer";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -725,7 +733,11 @@ const { intlayer, intlayerProxy } = require("vite-intlayer");
 
 // https://vitejs.dev/config/
 module.exports = defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -1049,7 +1061,7 @@ import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";
 
 const app = createApp(App);
 
-installIntlayer(app);
+app.use(intlayer);
 
 const md = new MarkdownIt({
   html: true, // allow HTML tags

package/docs/en-GB/packages/react-intlayer/MarkdownRenderer.md

@@ -28,7 +28,7 @@ The `MarkdownRenderer` component renders Markdown content using custom component
 ## Usage
 
 ```tsx
-import { MarkdownRenderer } from "react-intlayer";
+import { MarkdownRenderer } from "react-intlayer/markdown";
 
 const MyComponent = () => (
   <MarkdownRenderer># My Title My content</MarkdownRenderer>

package/docs/en-GB/packages/svelte-intlayer/useRewriteURL.md

@@ -29,7 +29,7 @@ Call the hook within a Svelte component.
 
 ```svelte
 <script>
-  import { useRewriteURL } from 'svelte-intlayer';
+  import { useRewriteURL } from "svelte-intlayer";
 
   // Automatically corrects /fr/tests to /fr/essais in the address bar if a rewrite rule exists
   useRewriteURL();

package/docs/en-GB/releases/v8.md

@@ -69,7 +69,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { MarkdownRenderer } from "react-intlayer";
+    import { MarkdownRenderer } from "react-intlayer/markdown";
 
     <MarkdownRenderer
       forceBlock={true}
@@ -84,7 +84,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useMarkdownRenderer } from "react-intlayer";
+    import { useMarkdownRenderer } from "react-intlayer/markdown";
 
     const renderMarkdown = useMarkdownRenderer({
       components: {
@@ -98,7 +98,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderMarkdown } from "react-intlayer";
+    import { renderMarkdown } from "react-intlayer/markdown";
 
     const html = renderMarkdown("# My Title", {
       forceBlock: true
@@ -112,7 +112,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```vue
     <script setup>
-    import { MarkdownRenderer } from "vue-intlayer";
+    import { MarkdownRenderer } from "vue-intlayer/markdown";
     </script>
 
     <template>
@@ -127,7 +127,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { MarkdownRenderer } from "svelte-intlayer";
+      import { MarkdownRenderer } from "svelte-intlayer/markdown";
     </script>
 
     <MarkdownRenderer forceBlock={true} value="# My Title" />
@@ -137,7 +137,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { useMarkdownRenderer } from "svelte-intlayer";
+      import { useMarkdownRenderer } from "svelte-intlayer/markdown";
       const render = useMarkdownRenderer();
     </script>
 
@@ -148,7 +148,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { renderMarkdown } from "svelte-intlayer";
+      import { renderMarkdown } from "svelte-intlayer/markdown";
     </script>
 
     {@html renderMarkdown("# My Title")}
@@ -179,7 +179,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { MarkdownRenderer } from "solid-intlayer";
+    import { MarkdownRenderer } from "solid-intlayer/markdown";
 
     <MarkdownRenderer forceBlock={true}>
       {"# My Title"}
@@ -189,7 +189,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useMarkdownRenderer } from "solid-intlayer";
+    import { useMarkdownRenderer } from "solid-intlayer/markdown";
 
     const render = useMarkdownRenderer();
 
@@ -199,7 +199,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderMarkdown } from "solid-intlayer";
+    import { renderMarkdown } from "solid-intlayer/markdown";
 
     return <div>{renderMarkdown("# My Title")}</div>;
     ```
@@ -210,7 +210,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { MarkdownRenderer } from "preact-intlayer";
+    import { MarkdownRenderer } from "preact-intlayer/markdown";
 
     <MarkdownRenderer forceBlock={true}>
       {"# My Title"}
@@ -220,7 +220,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useMarkdownRenderer } from "preact-intlayer";
+    import { useMarkdownRenderer } from "preact-intlayer/markdown";
 
     const render = useMarkdownRenderer();
 
@@ -230,7 +230,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderMarkdown } from "preact-intlayer";
+    import { renderMarkdown } from "preact-intlayer/markdown";
 
     return <div>{renderMarkdown("# My Title")}</div>;
     ```
@@ -246,7 +246,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { HTMLRenderer } from "react-intlayer";
+    import { HTMLRenderer } from "react-intlayer/html";
 
     <HTMLRenderer
       components={{
@@ -260,7 +260,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useHTMLRenderer } from "react-intlayer";
+    import { useHTMLRenderer } from "react-intlayer/html";
 
     const renderHTML = useHTMLRenderer({
       components: {
@@ -274,7 +274,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderHTML } from "react-intlayer";
+    import { renderHTML } from "react-intlayer/html";
 
     const html = renderHTML("<p>Hello World</p>");
     ```
@@ -286,7 +286,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```vue
     <script setup>
-    import { HTMLRenderer } from "vue-intlayer";
+    import { HTMLRenderer } from "vue-intlayer/html";
     </script>
 
     <template>
@@ -301,7 +301,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { HTMLRenderer } from "svelte-intlayer";
+      import { HTMLRenderer } from "svelte-intlayer/html";
     </script>
 
     <HTMLRenderer value="<p>Hello World</p>" />
@@ -311,7 +311,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { useHTMLRenderer } from "svelte-intlayer";
+      import { useHTMLRenderer } from "svelte-intlayer/html";
       const render = useHTMLRenderer();
     </script>
 
@@ -322,7 +322,7 @@ We have introduced new standalone renderer functions and components to give you
 
     ```svelte
     <script>
-      import { renderHTML } from "svelte-intlayer";
+      import { renderHTML } from "svelte-intlayer/html";
     </script>
 
     {@html renderHTML("<p>Hello World</p>")}
@@ -345,7 +345,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { HTMLRenderer } from "solid-intlayer";
+    import { HTMLRenderer } from "solid-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hello World</p>"}
@@ -355,7 +355,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useHTMLRenderer } from "solid-intlayer";
+    import { useHTMLRenderer } from "solid-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -365,7 +365,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderHTML } from "solid-intlayer";
+    import { renderHTML } from "solid-intlayer/html";
 
     return <div>{renderHTML("<p>Hello World</p>")}</div>;
     ```
@@ -376,7 +376,7 @@ We have introduced new standalone renderer functions and components to give you
     **1. Using the Component:**
 
     ```tsx
-    import { HTMLRenderer } from "preact-intlayer";
+    import { HTMLRenderer } from "preact-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hello World</p>"}
@@ -386,7 +386,7 @@ We have introduced new standalone renderer functions and components to give you
     **2. Using the Hook:**
 
     ```tsx
-    import { useHTMLRenderer } from "preact-intlayer";
+    import { useHTMLRenderer } from "preact-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -396,7 +396,7 @@ We have introduced new standalone renderer functions and components to give you
     **3. Using the Utility Function:**
 
     ```tsx
-    import { renderHTML } from "preact-intlayer";
+    import { renderHTML } from "preact-intlayer/html";
 
     return <div>{renderHTML("<p>Hello World</p>")}</div>;
     ```
@@ -1032,7 +1032,7 @@ Intlayer v8 includes a new caching layer for the Markdown and HTML compiler. Thi
    
     ```typescript fileName="vite.config.js"
     import { defineConfig } from 'vite';
-    import {intlayer, intlayerCompiler} from 'vite-intlayer';
+    import { intlayer, intlayerCompiler } from "vite-intlayer";
 
     export default defineConfig({
       plugins: [intlayer(), intlayerCompiler()],

package/docs/es/compiler.md

@@ -208,7 +208,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indica si los componentes deben guardarse después de ser transformados.
-     * De esta manera, el compilador puede ejecutarse una sola vez para transformar la aplicación y luego puede eliminarse.
+     *
+     * - Si es `true`, el compilador reescribirá el archivo del componente en el disco. Por lo tanto, la transformación será permanente y el compilador omitirá la transformación en el próximo proceso. De esta manera, el compilador puede transformar la aplicación y luego puede ser eliminado.
+     *
+     * - Si es `false`, el compilador inyectará la llamada a la función `useIntlayer()` en el código solo en la salida del build, y mantendrá intacta la base de código original. La transformación se realizará solo en memoria.
      */
     saveComponents: false,
 
@@ -287,6 +290,8 @@ Las siguientes propiedades pueden configurarse en el bloque `compiler` de tu arc
   - _Tipo_: `boolean`
   - _Por defecto_: `false`
   - _Descripción_: Indica si los componentes deben guardarse después de ser transformados.
+    - Si es `true`, el compilador reescribirá el archivo del componente en el disco. La transformación será permanente y el compilador podrá ser eliminado.
+    - Si es `false`, el compilador inyectará la llamada a la función `useIntlayer()` en el código solo en la salida del build, y mantendrá intacta la base de código original. La transformación se realizará solo en memoria.
 
 ### Rellenar traducciones faltantes
 

package/docs/es/configuration.md

@@ -518,7 +518,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indica si los componentes deben guardarse después de ser transformados.
-     * De esta manera, el compilador puede ejecutarse solo una vez para transformar la aplicación y luego puede eliminarse.
+     *
+     * - Si es `true`, el compilador reescribirá el archivo del componente en el disco. Por lo tanto, la transformación será permanente y el compilador omitirá la transformación en el próximo proceso. De esta manera, el compilador puede transformar la aplicación y luego puede ser eliminado.
+     *
+     * - Si es `false`, el compilador inyectará la llamada a la función `useIntlayer()` en el código solo en la salida del build, y mantendrá intacta la base de código original. La transformación se realizará solo en memoria.
      */
     saveComponents: false,
 
@@ -932,14 +935,14 @@ Estos ajustes son para casos de uso avanzados y configuración interna de Intlay
 
 Ajustes que controlan el compilador de Intlayer, que extrae diccionarios directamente de sus componentes.
 
-| Campo                 | Descripción                                                                                                                                                                                                                                                                                                            | Tipo                                                                                                            | Predeterminado | Ejemplo                                                                                                                                                  | Nota                                                                                                                                                                                                                          |
-| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `enabled`             | Indica si el compilador debe habilitarse para extraer diccionarios.                                                                                                                                                                                                                                                    | `boolean` &#124; <br/> `'build-only'`                                                                           | `true`         | `'build-only'`                                                                                                                                           | `'build-only'` se salta el compilador durante el desarrollo para acelerar las compilaciones; solo se ejecuta en comandos de build.                                                                                            |
-| `dictionaryKeyPrefix` | Prefijo para las claves de diccionarios extraídas.                                                                                                                                                                                                                                                                     | `string`                                                                                                        | `''`           | `'mi-prefijo-'`                                                                                                                                          | Se añade a la clave generada (basada en el nombre del archivo) para evitar conflictos.                                                                                                                                        |
-| `saveComponents`      | Indica si los componentes deben guardarse después de transformarse.                                                                                                                                                                                                                                                    | `boolean`                                                                                                       | `false`        |                                                                                                                                                          | • Si es `true`, reemplaza los archivos originales con las versiones transformadas.<br/>• El compilador puede eliminarse después de una ejecución.                                                                             |
-| `output`              | Define la ruta de archivos de salida. Reemplaza `outputDir`. Soporta variables de plantilla: `{{fileName}}`, <br/> `{{key}}`, <br/> `{{locale}}`, <br/> `{{extension}}`, <br/> `{{componentFileName}}`, <br/> `{{componentExtension}}`, <br/> `{{format}}`, <br/> `{{componentFormat}}`, <br/> `{{componentDirPath}}`. | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `undefined`    | `'./{{fileName}}{{extension}}'` <br/> `'/locales/{{locale}}/{{key}}.json'` <br/> `{ en: ({ key }) => './locales/en/${key}.json', fr: '...', es: false }` | • Las rutas `./` se resuelven respecto al directorio del componente.<br/>• Las rutas `/` respecto a la raíz.<br/>• `{{locale}}` dispara la generación separada por localidad.<br/>• Soporta notación de objeto por localidad. |
-| `noMetadata`          | Si es `true`, el compilador omite los metadatos del diccionario (clave, envoltorio de contenido) de la salida.                                                                                                                                                                                                         | `boolean`                                                                                                       | `false`        | `false` → `{"key":"mi-clave","content":{"key":"valor"}}` <br/> `true` → `{"key":"valor"}`                                                                | • Útil para salidas JSON i18next o ICU MessageFormat.<br/>• Funciona bien con el plugin `loadJSON`.                                                                                                                           |
-| `dictionaryKeyPrefix` | Prefijo de clave de diccionario                                                                                                                                                                                                                                                                                        | `string`                                                                                                        | `''`           |                                                                                                                                                          | Agregue un prefijo opcional para las llaves de los diccionarios extraídos                                                                                                                                                     |
+| Campo                 | Descripción                                                                                                                                                                                                                                                                                                            | Tipo                                                                                                            | Predeterminado | Ejemplo                                                                                                                                                  | Nota                                                                                                                                                                                                                                                                                                                                   |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `enabled`             | Indica si el compilador debe habilitarse para extraer diccionarios.                                                                                                                                                                                                                                                    | `boolean` &#124; <br/> `'build-only'`                                                                           | `true`         | `'build-only'`                                                                                                                                           | `'build-only'` se salta el compilador durante el desarrollo para acelerar las compilaciones; solo se ejecuta en comandos de build.                                                                                                                                                                                                     |
+| `dictionaryKeyPrefix` | Prefijo para las claves de diccionarios extraídas.                                                                                                                                                                                                                                                                     | `string`                                                                                                        | `''`           | `'mi-prefijo-'`                                                                                                                                          | Se añade a la clave generada (basada en el nombre del archivo) para evitar conflictos.                                                                                                                                                                                                                                                 |
+| `saveComponents`      | Indica si los componentes deben guardarse después de ser transformados.                                                                                                                                                                                                                                                | `boolean`                                                                                                       | `false`        |                                                                                                                                                          | • Si es `true`, el compilador reescribirá el archivo del componente en el disco. La transformación será permanente y el compilador podrá ser eliminado.<br/>• Si es `false`, el compilador inyectará la llamada a la función `useIntlayer()` en el código solo en la salida del build, y mantendrá intacta la base de código original. |
+| `output`              | Define la ruta de archivos de salida. Reemplaza `outputDir`. Soporta variables de plantilla: `{{fileName}}`, <br/> `{{key}}`, <br/> `{{locale}}`, <br/> `{{extension}}`, <br/> `{{componentFileName}}`, <br/> `{{componentExtension}}`, <br/> `{{format}}`, <br/> `{{componentFormat}}`, <br/> `{{componentDirPath}}`. | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `undefined`    | `'./{{fileName}}{{extension}}'` <br/> `'/locales/{{locale}}/{{key}}.json'` <br/> `{ en: ({ key }) => './locales/en/${key}.json', fr: '...', es: false }` | • Las rutas `./` se resuelven respecto al directorio del componente.<br/>• Las rutas `/` respecto a la raíz.<br/>• `{{locale}}` dispara la generación separada por localidad.<br/>• Soporta notación de objeto por localidad.                                                                                                          |
+| `noMetadata`          | Si es `true`, el compilador omite los metadatos del diccionario (clave, envoltorio de contenido) de la salida.                                                                                                                                                                                                         | `boolean`                                                                                                       | `false`        | `false` → `{"key":"mi-clave","content":{"key":"valor"}}` <br/> `true` → `{"key":"valor"}`                                                                | • Útil para salidas JSON i18next o ICU MessageFormat.<br/>• Funciona bien con el plugin `loadJSON`.                                                                                                                                                                                                                                    |
+| `dictionaryKeyPrefix` | Prefijo de clave de diccionario                                                                                                                                                                                                                                                                                        | `string`                                                                                                        | `''`           |                                                                                                                                                          | Agregue un prefijo opcional para las llaves de los diccionarios extraídos                                                                                                                                                                                                                                                              |
 
 ---