@intlayer/docs 5.8.0-canary.0 → 5.8.0

package/docs/en/intlayer_CMS.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Intlayer CMS | Externalize your content into the Intlayer CMS
 description: Externalize your content into the Intlayer CMS to delegate the management of your content to your team.
 keywords:
@@ -345,7 +345,6 @@ If you encounter any issues with the CMS, check the following:
 - The application is running.
 
 - The [`editor`](https://intlayer.org/doc/concept/configuration#editor-configuration) configuration are correctly set in your Intlayer configuration file.
-
   - Required fields:
     - The application URL should match the one you set in the editor configuration (`applicationURL`).
     - The CMS URL

package/docs/en/intlayer_visual_editor.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Intlayer Visual Editor | Edit your content using a visual editor
 description: Discover how to use the Intlayer Editor to manage your multilingual website. Follow the steps in this online documentation to set up your project in a few minutes.
 keywords:
@@ -257,7 +257,6 @@ If you encounter any issues with the visual editor, check the following:
 - The visual editor and the application are running.
 
 - The [`editor`](https://intlayer.org/doc/concept/configuration#editor-configuration) configuration are correctly set in your Intlayer configuration file.
-
   - Required fields:
     - The application URL should match the one you set in the editor configuration (`applicationURL`).
 

package/docs/en/intlayer_with_create_react_app.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Translate your Create React App (CRA) website (i18n)
 description: Discover how to make your Create React App (CRA) website multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:

package/docs/en/intlayer_with_express.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Translate your Express backend (i18n)
 description: Discover how to make your vite backend multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:

package/docs/en/intlayer_with_tanstack.md

@@ -2,7 +2,7 @@
 createdAt: 2025-08-11
 updatedAt: 2025-08-11
 title: Getting Started with Intlayer in TanStack Start (React)
-description: Add i18n to your TanStack Start app using Intlayer—component-level dictionaries, localized URLs, and SEO-friendly metadata.
+description: Add i18n to your TanStack Start app using Intlayer-component-level dictionaries, localized URLs, and SEO-friendly metadata.
 keywords:
   - Internationalization
   - Documentation

package/docs/en/introduction.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Introduction
 description: Discover how Intlayer works. See the steps used by Intlayer in your application. See what does the different packages do.
 keywords:
@@ -32,8 +32,8 @@ Intlayer also provides an optional visual editor that allows you to easily edit
 .
 └── Components
     └── MyComponent
-        ├── index.content.cjs
-        └── index.mjs
+        ├── index.content.ts
+        └── index.tsx
 ```
 
 ```tsx fileName="src/components/MyComponent/index.content.ts" contentDeclarationFormat="typescript"

package/docs/en/packages/express-intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | express-intlayer
 description: See how to use the express-intlayer package
 keywords:

package/docs/en/packages/intlayer/getConfiguration.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getConfiguration Function Documentation | intlayer
 description: See how to use the getConfiguration function for intlayer package
 keywords:
@@ -36,7 +36,6 @@ The function does not take any parameters. Instead, it uses environment variable
 
 - **Type**: `IntlayerConfig`
 - **Description**: An object containing the complete configuration for `intlayer`. The configuration includes the following sections:
-
   - `internationalization`: Settings related to locales and strict mode.
   - `middleware`: Settings related to URL and cookie management.
   - `content`: Settings related to content files, directories, and patterns.

package/docs/en/packages/intlayer/getEnumeration.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getEnumeration Function Documentation | intlayer
 description: See how to use the getEnumeration function for intlayer package
 keywords:
@@ -29,13 +29,11 @@ The `getEnumeration` function retrieves content corresponding to a specific quan
 ## Parameters
 
 - `enumerationContent: QuantityContent<Content>`
-
   - **Description**: An object where keys represent conditions (e.g., `<=`, `<`, `>=`, `=`) and values represent the corresponding content. The order of keys defines their matching priority.
   - **Type**: `QuantityContent<Content>`
     - `Content` can be any type.
 
 - `quantity: number`
-
   - **Description**: The numeric value used to match against the conditions in `enumerationContent`.
   - **Type**: `number`
 
@@ -141,15 +139,12 @@ console.log(content); // Output: "You have less than four"
 ## Edge Cases
 
 - **No Matching Condition:**
-
   - If no condition matches the provided quantity, the function will either return `undefined` or handle the default/fallback scenario explicitly.
 
 - **Ambiguous Conditions:**
-
   - If conditions overlap, the first matching condition (based on object order) takes precedence.
 
 - **Invalid Keys:**
-
   - The function assumes that all keys in `enumerationContent` are valid and parsable as conditions. Invalid or improperly formatted keys may lead to unexpected behavior.
 
 - **TypeScript Enforcement:**

package/docs/en/packages/intlayer/getHTMLTextDir.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getHTMLTextDir Function Documentation | intlayer
 description: See how to use the getHTMLTextDir function for intlayer package
 keywords:
@@ -29,7 +29,6 @@ The `getHTMLTextDir` function determines the text direction (`ltr`, `rtl`, or `a
 ## Parameters
 
 - `locale?: Locales`
-
   - **Description**: The locale string (e.g., `Locales.ENGLISH`, `Locales.ARABIC`) used to determine the text direction.
   - **Type**: `Locales` (optional)
 
@@ -72,7 +71,6 @@ getHTMLTextDir(Locales.ARABIC); // Output: "rtl"
 ## Edge Cases
 
 - **No Locale Provided:**
-
   - The function returns `'auto'` when `locale` is `undefined`.
 
 - **Unrecognized Locale:**

package/docs/en/packages/intlayer/getLocaleLang.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getLocaleLang Function Documentation | intlayer
 description: See how to use the getLocaleLang function for intlayer package
 keywords:
@@ -29,7 +29,6 @@ The `getLocaleLang` function extracts the language code from a locale string. It
 ## Parameters
 
 - `locale?: Locales`
-
   - **Description**: The locale string (e.g., `Locales.ENGLISH_UNITED_STATES`, `Locales.FRENCH_CANADA`) from which the language code is extracted.
   - **Type**: `Locales` (optional)
 
@@ -72,7 +71,6 @@ getLocaleLang(Locales.FRENCH); // Output: "fr"
 ## Edge Cases
 
 - **No Locale Provided:**
-
   - The function returns an empty string when `locale` is `undefined`.
 
 - **Malformed Locale Strings:**

package/docs/en/packages/intlayer/getLocaleName.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getLocaleName Function Documentation | intlayer
 description: See how to use the getLocaleName function for intlayer package
 keywords:
@@ -29,7 +29,6 @@ The `getLocaleName` function returns the localized name of a given locale (`targ
 ## Parameters
 
 - `displayLocale: Locales`
-
   - **Description**: The locale in which the name of the target locale will be displayed.
   - **Type**: Enum or string representing valid locales.
 

package/docs/en/packages/intlayer/getLocalizedUrl.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getLocalizedUrl Function Documentation | intlayer
 description: See how to use the getLocalizedUrl function for intlayer package
 keywords:
@@ -31,23 +31,19 @@ The `getLocalizedUrl` function generates a localized URL by prefixing the given
 ## Parameters
 
 - `url: string`
-
   - **Description**: The original URL string to be prefixed with a locale.
   - **Type**: `string`
 
 - `currentLocale: Locales`
-
   - **Description**: The current locale for which the URL is being localized.
   - **Type**: `Locales`
 
 - `locales: Locales[]`
-
   - **Description**: Optional array of supported locales. By defaults, the configured locales in the project are provided.
   - **Type**: `Locales[]`
   - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md#middleware)
 
 - `defaultLocale: Locales`
-
   - **Description**: The default locale for the application. By defaults, the configured default locale in the project are provided.
   - **Type**: `Locales`
   - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md#middleware)
@@ -172,11 +168,9 @@ getLocalizedUrl(
 ## Edge Cases
 
 - **No Locale Segment:**
-
   - If the URL does not contain any locale segment, the function safely prefixes the appropriate locale.
 
 - **Default Locale:**
-
   - When `prefixDefault` is `false`, the function does not prefix the URL for the default locale.
 
 - **Unsupported Locales:**

package/docs/en/packages/intlayer/getMultilingualUrls.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getMultilingualUrls Function Documentation | intlayer
 description: See how to use the getMultilingualUrls function for intlayer package
 keywords:
@@ -31,18 +31,15 @@ The `getMultilingualUrls` function generates a mapping of multilingual URLs by p
 ## Parameters
 
 - `url: string`
-
   - **Description**: The original URL string to be prefixed with locales.
   - **Type**: `string`
 
 - `locales: Locales[]`
-
   - **Description**: Optional array of supported locales. Defaults to the configured locales in the project.
   - **Type**: `Locales[]`
   - **Default**: `localesDefault`
 
 - `defaultLocale: Locales`
-
   - **Description**: The default locale for the application. Defaults to the configured default locale in the project.
   - **Type**: `Locales`
   - **Default**: `defaultLocaleDefault`
@@ -128,11 +125,9 @@ getMultilingualUrls(
 ## Edge Cases
 
 - **No Locale Segment:**
-
   - The function removes any existing locale segment from the URL before generating the multilingual mappings.
 
 - **Default Locale:**
-
   - When `prefixDefault` is `false`, the function does not prefix the URL for the default locale.
 
 - **Unsupported Locales:**

package/docs/en/packages/intlayer/getPathWithoutLocale.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getPathWithoutLocale Function Documentation | intlayer
 description: See how to use the getPathWithoutLocale function for intlayer package
 keywords:
@@ -29,7 +29,6 @@ Removes the locale segment from the given URL or pathname if present. It works w
 ## Parameters
 
 - `inputUrl: string`
-
   - **Description**: The complete URL string or pathname to process.
   - **Type**: `string`
 

package/docs/en/packages/intlayer/getTranslation.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: getTranslation Function Documentation | intlayer
 description: See how to use the getTranslation function for intlayer package
 keywords:
@@ -29,13 +29,11 @@ The `getTranslationContent` function retrieves the content corresponding to a sp
 ## Parameters
 
 - `languageContent: CustomizableLanguageContent<Content>`
-
   - **Description**: An object containing translations for various locales. Each key represents a locale, and its value is the corresponding content.
   - **Type**: `CustomizableLanguageContent<Content>`
     - `Content` can be any type, defaulting to `string`.
 
 - `locale: Locales`
-
   - **Description**: The locale for which content is to be retrieved.
   - **Type**: `Locales`
 

package/docs/en/packages/intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | intlayer
 description: See how to use the intlayer package
 keywords:

package/docs/en/packages/next-intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | next-intlayer
 description: See how to use the next-intlayer package
 keywords:

package/docs/en/packages/next-intlayer/t.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: t Function Documentation | next-intlayer
 description: See how to use the t function for next-intlayer package
 keywords:

package/docs/en/packages/next-intlayer/useDictionary.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useDictionary Hook Documentation | next-intlayer
 description: See how to use the useDictionary hook for next-intlayer package
 keywords:

package/docs/en/packages/next-intlayer/useIntlayer.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useIntlayer Hook Documentation | next-intlayer
 description: See how to use the useIntlayer hook for next-intlayer package
 keywords:

package/docs/en/packages/next-intlayer/useLocale.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useLocale Hook Documentation | next-intlayer
 description: See how to use the useLocale hook for next-intlayer package
 keywords:

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

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | react-intlayer
 description: See how to use the react-intlayer package
 keywords:

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

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: t Function Documentation | react-intlayer
 description: See how to use the t function for react-intlayer package
 keywords:

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

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useI18n Hook Documentation | react-intlayer
 description: Learn how to use the useI18n hook in the react-intlayer package
 keywords:

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

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useIntlayer Hook Documentation | react-intlayer
 description: See how to use the useIntlayer hook for react-intlayer package
 keywords:

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

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: useLocale Hook Documentation | react-intlayer
 description: See how to use the useLocale hook for react-intlayer package
 keywords:

package/docs/en/packages/react-scripts-intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | react-scripts-intlayer
 description: See how to use the react-scripts-intlayer package
 keywords:

package/docs/en/packages/solid-intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | solid-intlayer
 description: See how to use the solid-intlayer package
 keywords:

package/docs/en/packages/vite-intlayer/index.md

@@ -1,6 +1,6 @@
 ---
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
 title: Package Documentation | vite-intlayer
 description: See how to use the vite-intlayer package
 keywords: