@intlayer/docs 8.1.6 → 8.1.8

package/docs/en-GB/configuration.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-13
-updatedAt: 2026-02-12
+updatedAt: 2026-02-25
 title: Configuration
 description: Learn how to configure Intlayer for your application. Understand the various settings and options available to customise Intlayer to your needs.
 keywords:
@@ -14,6 +14,9 @@ slugs:
   - concept
   - configuration
 history:
+  - version: 8.1.7
+    date: 2026-02-25
+    changes: Update compiler options
   - version: 8.0.6
     date: 2026-02-12
     changes: Add support for Open Router, Alibaba, Amazon, Google Vertex Bedrock, Fireworks, Groq, Hugging Face, and Together.ai providers
@@ -437,6 +440,17 @@ const config: IntlayerConfig = {
      * Output directory for the optimized dictionaries.
      */
     outputDir: "compiler",
+
+    /**
+     * Dictionary key prefix
+     */
+    dictionaryKeyPrefix: "", // Remove base prefix
+
+    /**
+     * 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.
+     */
+    saveComponents: false,
   },
 
   /**
@@ -988,6 +1002,13 @@ Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
   - _Note_: Fetch mode will use the live sync API to fetch the dictionaries. If the API call fails, the dictionaries will be imported dynamically as "dynamic" mode.
   - _Note_: This option will not affect the `getIntlayer`, `getDictionary`, `useDictionary`, `useDictionaryAsync` and `useDictionaryDynamic` functions.
 
+- **outputFormat**:
+  - _Type_: `'esm' | 'cjs'`
+  - _Default_: `'esm'`
+  - _Description_: Controls the output format of the dictionaries.
+  - _Example_: `'cjs'`
+  - _Note_: The output format of the dictionaries.
+
 - **traversePattern**:
   - _Type_: `string[]`
   - _Default_: `['**\/*.{js,ts,mjs,cjs,jsx,tsx}', '!**\/node_modules/**']`
@@ -996,3 +1017,49 @@ Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
   - _Note_: Use this to limit optimisation to relevant code files and improve build performance.
   - _Note_: This option will be ignored if `optimise` is disabled.
   - _Note_: Use glob pattern.
+
+---
+
+### Compiler Configuration
+
+Settings that control the Intlayer compiler, which extracts dictionaries straight from your components.
+
+#### Properties
+
+- **enabled**:
+  - _Type_: `boolean | 'build-only'`
+  - _Default_: `true`
+  - _Description_: Indicates if the compiler should be enabled to extract the dictionaries.
+  - _Example_: `'build-only'`
+  - _Note_: Setting it to `'build-only'` will skip the compiler during development mode to speed up build times. It will only run on build commands.
+
+- **dictionaryKeyPrefix**:
+  - _Type_: `string`
+  - _Default_: `'comp-'`
+  - _Description_: Prefix for the extracted dictionary keys.
+  - _Example_: `'my-key-'`
+  - _Note_: When dictionaries are extracted, the key is generated based on the file name. This prefix is added to the generated key to prevent conflicts.
+
+- **saveComponents**:
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Indicates if the components should be saved after being transformed.
+  - _Note_: If true, the compiler will replace the original files with the transformed files. That way, the compiler can be run only once to transform the app, and then it can be removed.
+
+- **transformPattern**:
+  - _Type_: `string | string[]`
+  - _Default_: `['**/*.{ts,tsx,jsx,js,cjs,mjs,svelte,vue}', '!**/node_modules/**']`
+  - _Description_: Patterns that define which files should be traversed during optimisation.
+  - _Example_: `['src/**/*.{ts,tsx}', '!**/node_modules/**']`
+  - _Note_: Use this to limit optimisation to relevant code files and improve build performance.
+
+- **excludePattern**:
+  - _Type_: `string | string[]`
+  - _Default_: `['**/node_modules/**']`
+  - _Description_: Patterns that define which files should be excluded during optimisation.
+  - _Example_: `['**/node_modules/**', '!**/node_modules/react/**']`
+
+- **outputDir**:
+  - _Type_: `string`
+  - _Default_: `'compiler'`
+  - _Description_: The directory where the extracted dictionaries will be stored, relative to your project base path.

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

@@ -490,7 +490,7 @@ Indicates the location of the dictionary and controls how it synchronises with t
 
 - `'local'`: The dictionary is managed locally only. It will not be pushed to the remote CMS. Use this for content that should remain in your codebase.
 - `'remote'`: The dictionary is managed remotely only. Once pushed to the CMS, it will be detached from the local file. At content load time, the remote dictionary will be pulled from the CMS. A `.content` file with `remote` location will be ignored after the initial push.
-- `'hybrid'`: The dictionary is managed both locally and remotely. Once pushed to the CMS, it will stay synchronised—changes from the local file are pushed to the CMS, and remote changes can be pulled back to the local file.
+- `'hybrid'`: The dictionary is managed both locally and remotely. Once pushed to the CMS, it will stay synchronised, changes from the local file are pushed to the CMS, and remote changes can be pulled back to the local file.
 - `string` (e.g., `'plugin'`): The dictionary is managed by a plugin or a custom source. When you try to push it, the system will ask you what to do.
 
 **Example:**

package/docs/en-GB/index.md

@@ -64,7 +64,7 @@ Organise your multilingual content close to your code to keep everything consist
 - **[Enumeration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/enumeration.md)**  
   Easily manage repeated or fixed sets of data across various languages.
 
-- **[Condition](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/conditional.md)**  
+- **[Condition](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/condition.md)**  
   Learn how to use conditional logic in Intlayer to create dynamic content.
 
 - **[Insertion](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/insertion.md)**
@@ -76,7 +76,7 @@ Organise your multilingual content close to your code to keep everything consist
 - **[Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/markdown.md)**  
   Learn how to use Markdown in Intlayer to create rich content.
 
-- **[File embeddings](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/file_embeddings.md)**  
+- **[File embeddings](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/file.md)**  
   Discover how to embed external files in Intlayer to use them in the content editor.
 
 - **[Nesting](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/nesting.md)**  

package/docs/en-GB/intlayer_CMS.md

@@ -447,7 +447,7 @@ Example using Vite:
 
 The Live Sync server wraps your application and automatically applies updated content as it arrives.
 
-To receive change notifications from the CMS, the Live Sync server maintains an SSE connection to the backend. When content changes in the CMS, the backend forwards the update to the Live Sync server, which writes the new dictionaries. Your application will reflect the update on the next navigation or browser reload—no rebuild required.
+To receive change notifications from the CMS, the Live Sync server maintains an SSE connection to the backend. When content changes in the CMS, the backend forwards the update to the Live Sync server, which writes the new dictionaries. Your application will reflect the update on the next navigation or browser reload, no rebuild required.
 
 Flow chart (CMS/Backend -> Live Sync Server -> Application Server -> Frontend):
 

package/docs/en-GB/intlayer_with_adonisjs.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-08-23
 updatedAt: 2025-12-30
-title: AdonisJS i18n - How to translate your AdonisJS app – guide 2026
+title: AdonisJS i18n - How to translate an AdonisJS app in 2026
 description: Discover how to make your AdonisJS backend multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_analog.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-04-18
 updatedAt: 2025-12-30
-title: Analog i18n - How to translate your Analog app – guide 2026
+title: Analog i18n - How to translate an Analog app in 2026
 description: Discover how to make your Analog app multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_angular.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-04-18
 updatedAt: 2025-12-30
-title: Angular i18n - How to translate your Angular app – guide 2026
+title: Angular i18n - How to translate an Angular app in 2026
 description: Discover how to make your Angular website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_astro.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-03-07
 updatedAt: 2025-12-30
-title: Astro i18n - How to translate your Astro app – guide 2026
+title: Astro i18n - How to translate an Astro app in 2026
 description: Learn how to add internationalisation (i18n) to your Astro website using Intlayer. Follow this guide to make your site multilingual.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_create_react_app.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-08-11
 updatedAt: 2025-12-30
-title: Create React App i18n - How to translate your React app – guide 2026
+title: Create React App i18n - How to translate an React app in 2026
 description: Discover how to make your Create React App (CRA) website multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization

package/docs/en-GB/intlayer_with_express.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-08-11
 updatedAt: 2025-12-30
-title: Express i18n - How to translate your Express app – guide 2026
+title: Express i18n - How to translate an Express app in 2026
 description: Discover how to make your Express backend multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization

package/docs/en-GB/intlayer_with_fastify.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-12-30
 updatedAt: 2025-12-30
-title: Fastify i18n - How to translate your Fastify app – guide 2026
+title: Fastify i18n - How to translate an Fastify app in 2026
 description: Discover how to make your Fastify back end multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalization

package/docs/en-GB/intlayer_with_hono.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-08-23
 updatedAt: 2025-12-30
-title: Hono i18n - How to translate your Hono app – guide 2026
+title: Hono i18n - How to translate an Hono app in 2026
 description: Discover how to make your Hono backend multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization

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

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-03-09
 updatedAt: 2025-12-30
-title: Lynx and React i18n - How to translate your Lynx app – guide 2026
+title: Lynx and React i18n - How to translate an Lynx app in 2026
 description: Discover how to make your Lynx and React mobile app multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_nestjs.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-09-09
 updatedAt: 2025-12-30
-title: NestJS i18n - How to translate your NestJS app – guide 2026
+title: NestJS i18n - How to translate an NestJS app in 2026
 description: Discover how to make your NestJS backend multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

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

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-10-05
 updatedAt: 2025-10-05
-title: Next.js and next-i18next i18n - How to translate your Next.js app – guide 2026
+title: next-i18next - How to translate a Next.js (i18n) app in 2026
 description: A practical, production-ready guide to internationalise a Next.js 15 App Router app with i18next/next-i18next and enhance it with Intlayer.
 keywords:
   - Internationalisation
@@ -37,7 +37,7 @@ applicationTemplate: https://github.com/aymericzip/intlayer-next-i18next-templat
 - Intlayer integration to automate translation workflows (tests, AI fill, JSON sync)
 
 > Note: next-i18next is built on top of i18next. This guide uses the i18next primitives compatible with next-i18next in the App Router, while keeping the architecture simple and production-ready.
-> For a broader comparison, see [next-i18next vs next-i18next vs Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/blog/{{locale}}/next-i18next_vs_next-i18next_vs_intlayer.md).
+> For a broader comparison, see [next-i18next vs next-intl vs Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/blog/en-GB/next-i18next_vs_next-intl_vs_intlayer.md).
 
 ---
 

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

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-10-05
 updatedAt: 2025-10-05
-title: Next.js and next-intl i18n - How to translate your Next.js app – guide 2026
+title: next-intl - How to translate a Next.js (i18n) app in 2026
 description: Discover how to make your Next.js 15 App Router website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -21,7 +21,7 @@ applicationTemplate: https://github.com/aymericzip/intlayer-next-intl-template
 
 This guide walks you through next-intl best practices in a Next.js 15 (App Router) app, and shows how to layer Intlayer on top for robust translation management and automation.
 
-See the comparison in [next-i18next vs next-intl vs Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/blog/{{locale}}/next-i18next_vs_next-intl_vs_intlayer.md).
+See the comparison in [next-i18next vs next-intl vs Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/blog/en-GB/next-i18next_vs_next-intl_vs_intlayer.md).
 
 - For juniors: follow step-by-step sections to obtain a working multilingual app.
 - For mid-level developers: pay attention to payload optimisation and server/client separation.

package/docs/en-GB/intlayer_with_nextjs_14.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-12-06
 updatedAt: 2025-12-30
-title: Next.js i18n - How to translate your Next.js 14 app – guide 2026
+title: Next.js i18n - How to translate an Next.js 14 app in 2026
 description: Discover how to make your Next.js 14 App Router website multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization
@@ -1428,7 +1428,7 @@ Link.displayName = 'Link';
 
 By integrating this `Link` component across your application, you maintain a coherent and language-aware user experience while also benefitting from improved SEO and usability.
 
-### (Optional) Step 12: Optmize your bundle size
+### (Optional) Step 12: Optimize your bundle size
 
 When using `next-intlayer`, dictionaries are included in the bundle for every page by default. To optimize bundle size, Intlayer provides an optional SWC plugin that intelligently replace `useIntlayer` calls using macros. This ensures dictionaries are only included in bundles for pages that actually use them.
 

package/docs/en-GB/intlayer_with_nextjs_15.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-12-06
 updatedAt: 2025-12-30
-title: Next.js i18n - How to translate your Next.js 15 app – guide 2026
+title: Next.js i18n - How to translate an Next.js 15 app in 2026
 description: Discover how to make your Next.js 15 website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation

package/docs/en-GB/intlayer_with_nextjs_16.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-12-06
 updatedAt: 2025-12-30
-title: Next.js i18n - How to translate your Next.js 16 app – guide 2026
+title: Next.js i18n - How to translate an Next.js 16 app in 2026
 description: Discover how to make your Next.js 16 website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation