@intlayer/docs 8.4.10 → 8.5.0

package/docs/en/intlayer_with_vite+vue.md

@@ -592,7 +592,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';
@@ -682,7 +682,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(),
+  ],
 });
 ```
 
@@ -693,7 +697,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(),
+  ],
 });
 ```
 
@@ -704,7 +712,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(),
+  ],
 });
 ```
 
@@ -983,7 +995,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - 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,
 
@@ -1014,7 +1029,10 @@ const config = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - 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,
 
@@ -1045,7 +1063,10 @@ const config = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - 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,
 

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

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

package/docs/en/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 correct /fr/tests to /fr/essais in the address bar if a rewrite rule exists
   useRewriteURL();

package/docs/en/readme.md

@@ -197,6 +197,7 @@ Explore our comprehensive documentation to get started with Intlayer and learn h
   <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
   <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
   <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-lit" rel=''>Vite + Lit</a></li>
   <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
   <li>
      <a href="https://intlayer.org/doc/environment/express" rel=''>Backend</a>

package/docs/en/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/en-GB/compiler.md

@@ -208,7 +208,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - 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,
 

package/docs/en-GB/configuration.md

@@ -518,7 +518,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - 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,
 

package/docs/en-GB/dictionary/html.md

@@ -241,7 +241,7 @@ You can configure HTML rendering globally for your entire application. This is i
   <Tab label="React / Next.js" value="react">
   
     ```tsx fileName="AppProvider.tsx"
-    import { HTMLProvider } from "react-intlayer";
+    import { HTMLProvider } from "react-intlayer/html";
 
     export const AppProvider = ({ children }) => (
       <HTMLProvider
@@ -281,7 +281,7 @@ You can configure HTML rendering globally for your entire application. This is i
    
     ```svelte fileName="App.svelte"
     <script lang="ts">
-      import { HTMLProvider } from "svelte-intlayer";
+      import { HTMLProvider } from "svelte-intlayer/html";
       import MyCustomP from "./MyCustomP.svelte";
     </script>
 
@@ -298,7 +298,7 @@ You can configure HTML rendering globally for your entire application. This is i
   <Tab label="Preact" value="preact">
    
     ```tsx fileName="AppProvider.tsx"
-    import { HTMLProvider } from "preact-intlayer";
+    import { HTMLProvider } from "preact-intlayer/html";
 
     export const AppProvider = ({ children }) => (
       <HTMLProvider
@@ -315,7 +315,7 @@ You can configure HTML rendering globally for your entire application. This is i
   <Tab label="Solid" value="solid">
    
     ```tsx fileName="AppProvider.tsx"
-    import { HTMLProvider } from "solid-intlayer";
+    import { HTMLProvider } from "solid-intlayer/html";
 
     export const AppProvider = (props) => (
       <HTMLProvider
@@ -332,11 +332,11 @@ You can configure HTML rendering globally for your entire application. This is i
   <Tab label="Angular" value="angular">
 
     ```typescript fileName="app.config.ts"
-    import { createIntlayerMarkdownProvider } from "angular-intlayer";
+    import { createIntlayerHTMLProvider } from "angular-intlayer/html";
 
     export const appConfig: ApplicationConfig = {
       providers: [
-        createIntlayerMarkdownProvider({
+        createIntlayerHTMLProvider({
           components: {
             p: { class: "prose" },
             CustomLink: { href: "/details" },
@@ -361,7 +361,7 @@ If you need to render raw HTML strings or have more control over the component m
     Render an HTML string with specific components.
 
     ```tsx
-    import { HTMLRenderer } from "react-intlayer";
+    import { HTMLRenderer } from "react-intlayer/html";
 
     <HTMLRenderer components={{ p: MyCustomP }}>
       {"<p>Hello World</p>"}
@@ -373,7 +373,7 @@ If you need to render raw HTML strings or have more control over the component m
     Get a pre-configured renderer function.
 
     ```tsx
-    import { useHTMLRenderer } from "react-intlayer";
+    import { useHTMLRenderer } from "react-intlayer/html";
 
     const renderHTML = useHTMLRenderer({
       components: { strong: (props) => <strong {...props} className="text-red-500" /> }
@@ -387,7 +387,7 @@ If you need to render raw HTML strings or have more control over the component m
     Standalone utility for rendering outside of components.
 
     ```tsx
-    import { renderHTML } from "react-intlayer";
+    import { renderHTML } from "react-intlayer/html";
 
     const jsx = renderHTML("<p>Hello</p>", { components: { p: 'div' } });
     ```
@@ -399,7 +399,7 @@ If you need to render raw HTML strings or have more control over the component m
    
     ```vue
     <script setup>
-    import { HTMLRenderer } from "vue-intlayer";
+    import { HTMLRenderer } from "vue-intlayer/html";
     </script>
 
     <template>
@@ -414,7 +414,7 @@ If you need to render raw HTML strings or have more control over the component m
    
     ```svelte
     <script lang="ts">
-    import { HTMLRenderer } from "svelte-intlayer";
+    import { HTMLRenderer } from "svelte-intlayer/html";
     </script>
 
     <HTMLRenderer value="<p>Hello World</p>" />
@@ -424,7 +424,7 @@ If you need to render raw HTML strings or have more control over the component m
 
     ```svelte
     <script lang="ts">
-    import { useHTMLRenderer } from "svelte-intlayer";
+    import { useHTMLRenderer } from "svelte-intlayer/html";
     const render = useHTMLRenderer();
     </script>
 
@@ -435,7 +435,7 @@ If you need to render raw HTML strings or have more control over the component m
 
     ```svelte
     <script lang="ts">
-    import { renderHTML } from "svelte-intlayer";
+    import { renderHTML } from "svelte-intlayer/html";
     </script>
 
     {@html renderHTML("<p>Hello World</p>")}
@@ -447,7 +447,7 @@ If you need to render raw HTML strings or have more control over the component m
     #### `<HTMLRenderer />` Component
    
     ```tsx
-    import { HTMLRenderer } from "preact-intlayer";
+    import { HTMLRenderer } from "preact-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hello World</p>"}
@@ -457,7 +457,7 @@ If you need to render raw HTML strings or have more control over the component m
     #### `useHTMLRenderer()` Hook
 
     ```tsx
-    import { useHTMLRenderer } from "preact-intlayer";
+    import { useHTMLRenderer } from "preact-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -467,7 +467,7 @@ If you need to render raw HTML strings or have more control over the component m
     #### `renderHTML()` Utility
 
     ```tsx
-    import { renderHTML } from "preact-intlayer";
+    import { renderHTML } from "preact-intlayer/html";
 
     return <div>{renderHTML("<p>Hello World</p>")}</div>;
     ```
@@ -478,7 +478,7 @@ If you need to render raw HTML strings or have more control over the component m
     #### `<HTMLRenderer />` Component
    
     ```tsx
-    import { HTMLRenderer } from "solid-intlayer";
+    import { HTMLRenderer } from "solid-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hello World</p>"}
@@ -488,7 +488,7 @@ If you need to render raw HTML strings or have more control over the component m
     #### `useHTMLRenderer()` Hook
 
     ```tsx
-    import { useHTMLRenderer } from "solid-intlayer";
+    import { useHTMLRenderer } from "solid-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -498,21 +498,21 @@ If you need to render raw HTML strings or have more control over the component m
     #### `renderHTML()` Utility
 
     ```tsx
-    import { renderHTML } from "solid-intlayer";
+    import { renderHTML } from "solid-intlayer/html";
 
     return <div>{renderHTML("<p>Hello World</p>")}</div>;
     ```
 
   </Tab>
   <Tab label="Angular" value="angular">
-    #### `IntlayerMarkdownService` Service
+    #### `IntlayerHTMLService` Service
     Render an HTML string using the service.
 
     ```typescript
-    import { IntlayerMarkdownService } from "angular-intlayer";
+    import { IntlayerHTMLService } from "angular-intlayer";
 
     export class MyComponent {
-      constructor(private markdownService: IntlayerMarkdownService) {}
+      constructor(private markdownService: IntlayerHTMLService) {}
 
       renderHTML(html: string) {
         return this.markdownService.renderMarkdown(html);