@intlayer/docs 6.1.6-canary.0 → 7.0.0-canary.0

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - condition
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Conditional Content / Condition in Intlayer
@@ -231,7 +235,3 @@ For more detailed information on configuration and usage, refer to the following
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_15.md)
 
 These resources offer further insights into the setup and usage of Intlayer across various environments and frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

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

@@ -11,6 +11,13 @@ slugs:
   - doc
   - concept
   - content
+history:
+  - version: 6.0.0
+    date: 2025-09-20
+    changes: Add fields documentation
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Content File
@@ -1075,10 +1082,3 @@ module.exports = {
 
 - Use live dictionaries only when real-time updates are necessary, (e.g. A/B testing, etc.)
 - Ensure the build transformation plugin (`@intlayer/swc`, or `@intlayer/babel`) is enabled to optimise the dictionary at build time
-
-## Doc History
-
-| Version | Date       | Changes                  |
-| ------- | ---------- | ------------------------ |
-| 6.0.0   | 2025-09-20 | Add fields documentation |
-| 5.5.10  | 2025-06-29 | Init history             |

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - enumeration
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Initial history
 ---
 
 # Enumeration / Pluralisation
@@ -239,7 +243,3 @@ For more detailed information on configuration and usage, refer to the following
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_with_nextjs_15.md)
 
 These resources provide further insights into the setup and usage of Intlayer in different environments and with various frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - file
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Initial history
 ---
 
 # File Content / Embedding Files in Intlayer
@@ -216,7 +220,3 @@ For more details on configuring and using file embedding in Intlayer, refer to t
 - [Translation Content Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/translation.md)
 
 These resources provide further insights into file embedding, content management, and Intlayer’s integration with various frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - gender
+history:
+  - version: 5.7.2
+    date: 2025-07-27
+    changes: Introduce gender-based content
 ---
 
 # Gender-Based Content / Gender in Intlayer
@@ -267,9 +271,3 @@ For more detailed information on configuration and usage, refer to the following
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_with_nextjs_15.md)
 
 These resources offer further insights into the setup and usage of Intlayer across various environments and frameworks.
-
-## Doc History
-
-| Version | Date       | Changes                        |
-| ------- | ---------- | ------------------------------ |
-| 5.7.2   | 2025-07-27 | Introduce gender-based content |

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - insertion
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Initial history
 ---
 
 # Insertion Content / Insertion in Intlayer
@@ -213,7 +217,3 @@ For more detailed information on configuration and usage, refer to the following
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_with_nextjs_15.md)
 
 These resources provide further insights into the setup and usage of Intlayer across various environments and frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - markdown
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Markdown / Rich Text Content
@@ -373,7 +377,3 @@ const IntlayerMarkdownProvider = ({ children }) => (
 - [markdown-to-jsx on npm](https://www.npmjs.com/package/markdown-to-jsx)
 
 These resources provide further insights into setting up and using Intlayer with various content types and frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - nesting
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Nesting / Sub Content Referencing
@@ -267,7 +271,3 @@ For more detailed information on configuration and usage, refer to the following
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_15.md)
 
 These resources provide further insights into the setup and usage of Intlayer in different environments and with various frameworks.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

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

@@ -16,6 +16,10 @@ slugs:
   - concept
   - content
   - translation
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Translation
@@ -303,7 +307,3 @@ module.exports = {
   }
 }
 ```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

package/docs/en-GB/formatters.md

@@ -18,6 +18,25 @@ keywords:
 slugs:
   - doc
   - formatters
+history:
+  - version: 5.8.0
+    date: 2025-08-20
+    changes: Add Vue formatters
+  - version: 5.8.0
+    date: 2025-08-18
+    changes: Add formatters documentation
+  - version: 5.8.0
+    date: 2025-08-20
+    changes: Add list formatter documentation
+  - version: 5.8.0
+    date: 2025-08-20
+    changes: Add additional Intl utilities (DisplayNames, Collator, PluralRules)
+  - version: 5.8.0
+    date: 2025-08-20
+    changes: Add locale utilities (getLocaleName, getLocaleLang, getLocaleFromPath, etc.)
+  - version: 5.8.0
+    date: 2025-08-20
+    changes: Add content handling utilities (getContent, getTranslation, getIntlayer, etc.)
 ---
 
 # Intlayer Formatters
@@ -46,7 +65,6 @@ import {
   getLocalizedUrl,
   getHTMLTextDir,
   getContent,
-  getLocalisedContent,
   getTranslation,
   getIntlayer,
   getIntlayerAsync,
@@ -256,26 +274,6 @@ const content = getContent(
 - **nodeProps**: Properties for the transformation context
 - **locale**: Optional locale (defaults to configured default locale)
 
-### `getLocalisedContent(node, locale, nodeProps, fallback?)`
-
-Transforms a content node with only the translation plugin:
-
-```ts
-import { getLocalisedContent } from "intlayer";
-
-const content = getLocalisedContent(
-  contentNode,
-  "fr",
-  { dictionaryKey: "common" },
-  true // fallback to default locale if translation missing
-);
-```
-
-- **node**: The content node to transform
-- **locale**: The locale to use for translation
-- **nodeProps**: Properties for the transformation context
-- **fallback**: Whether to fallback to the default locale (defaults to false)
-
 ### `getTranslation(languageContent, locale?, fallback?)`
 
 Extracts content for a specific locale from a language content object:
@@ -507,7 +505,6 @@ import {
   getLocalizedUrl,
   getHTMLTextDir,
   getContent,
-  getLocalisedContent,
   getTranslation,
   getIntlayer,
   getIntlayerAsync,
@@ -612,14 +609,3 @@ import {
 ```
 
 > These composables will consider the locale from the injected `IntlayerProvider`
-
-## Doc History
-
-| Version | Date       | Changes                                                                        |
-| ------- | ---------- | ------------------------------------------------------------------------------ |
-| 5.8.0   | 2025-08-20 | Add Vue formatters                                                             |
-| 5.8.0   | 2025-08-18 | Add formatters documentation                                                   |
-| 5.8.0   | 2025-08-20 | Add list formatter documentation                                               |
-| 5.8.0   | 2025-08-20 | Add additional Intl utilities (DisplayNames, Collator, PluralRules)            |
-| 5.8.0   | 2025-08-20 | Add locale utilities (getLocaleName, getLocaleLang, getLocaleFromPath, etc.)   |
-| 5.8.0   | 2025-08-20 | Add content handling utilities (getContent, getTranslation, getIntlayer, etc.) |

package/docs/en-GB/how_works_intlayer.md

@@ -13,6 +13,10 @@ slugs:
   - doc
   - concept
   - how-works-intlayer
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # How Intlayer Works
@@ -87,7 +91,7 @@ For externalised dictionaries using the CMS, Intlayer performs a basic fetch ope
 
 Intlayer also provides a visual editor to allow you to edit your content in a visual way. This [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) is available in the external `intlayer-editor` package.
 
-![visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.gif)
+![visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.gif?raw=true)
 
 - The server is a simple Express application that listens to requests from the client and retrieves the content of your application, such as the `dictionaries` and the configuration to make it accessible on the client side.
 - On the other hand, the client is a React application that is used to interact with your content using a visual interface.
@@ -259,7 +263,3 @@ The `@intlayer/backend` package exports backend types and will eventually offer
 ## Chat with our smart documentation
 
 - [Ask your questions to our smart documentation](https://intlayer.org/doc/chat)
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

package/docs/en-GB/index.md

@@ -16,6 +16,10 @@ keywords:
 slugs:
   - doc
   - index
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Intlayer Documentation
@@ -164,7 +168,3 @@ Seamlessly integrate with **Next.js**:
 We value the power of open-source and community-driven development. If you’d like to propose improvements, add a new guide, or correct any issues in our docs, feel free to submit a Pull Request or open an issue on our [GitHub repository](https://github.com/aymericzip/intlayer/blob/main/docs/docs).
 
 **Ready to translate your application faster and more efficiently?** Dive into our docs to start using Intlayer today. Experience a robust, streamlined approach to internationalisation that keeps your content organised and your team more productive.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

package/docs/en-GB/interest_of_intlayer.md

@@ -12,6 +12,13 @@ keywords:
 slugs:
   - doc
   - why
+history:
+  - version: 5.8.0
+    date: 2025-08-19
+    changes: Updated comparative table
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Initial history
 ---
 
 # Why you should consider Intlayer?
@@ -258,10 +265,3 @@ This approach allows you to:
 | **Tree-shaking (load only used content)**     | Yes, per-component at build time via Babel/SWC plugins                                                                           | Usually loads all (can be improved with namespaces/code-splitting) | Usually loads all                                  | Not default                                        | Partial                                            | Partial                                            | Partial (with code-splitting/manual setup)                |
 | **Lazy loading**                              | Yes, per-locale/per-component                                                                                                    | Yes (e.g., backends/namespaces on demand)                          | Yes (split locale bundles)                         | Yes (dynamic catalogue imports)                    | Yes (per-route/per-locale)                         | Yes (per-route/per-locale)                         | Yes (async locale messages)                               |
 | **Management of Large Projects**              | Encourages modularity, suited for design systems                                                                                 | Requires good file discipline                                      | Central catalogues can become large                | Can become complex                                 | Modular with setup                                 | Modular with setup                                 | Modular with Vue Router/Nuxt i18n setup                   |
-
-## Document History
-
-| Version | Date       | Changes                   |
-| ------- | ---------- | ------------------------- |
-| 5.8.0   | 2025-08-19 | Updated comparative table |
-| 5.5.10  | 2025-06-29 | Initial history           |

package/docs/en-GB/intlayer_CMS.md

@@ -17,6 +17,16 @@ slugs:
   - concept
   - cms
 youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
+history:
+  - version: 6.0.1
+    date: 2025-09-22
+    changes: Add live sync documentation
+  - version: 6.0.0
+    date: 2025-09-04
+    changes: Replace `hotReload` field with `liveSync`
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Initialise history
 ---
 
 # Intlayer Content Management System (CMS) Documentation
@@ -25,23 +35,23 @@ youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
 
 The Intlayer CMS is an application that allows you to externalise the content of an Intlayer project.
 
-For this, Intlayer introduces the concept of 'distant dictionaries'.
+For this, Intlayer introduces the concept of 'remote dictionaries'.
 
 ![Intlayer CMS Interface](https://github.com/aymericzip/intlayer/blob/main/docs/assets/CMS.png)
 
-## Understanding distant dictionaries
+## Understanding remote dictionaries
 
-Intlayer distinguishes between 'local' and 'distant' dictionaries.
+Intlayer distinguishes between 'local' and 'remote' dictionaries.
 
 - A 'local' dictionary is a dictionary that is declared in your Intlayer project. Such as the declaration file of a button, or your navigation bar. Externalising your content does not make sense in this case because this content is not supposed to change often.
 
-- A 'distant' dictionary is a dictionary that is managed through the Intlayer CMS. It could be useful to allow your team to manage your content directly on your website, and also aims to use A/B testing features and SEO automatic optimisation.
+- A 'remote' dictionary is a dictionary that is managed through the Intlayer CMS. It could be useful to allow your team to manage your content directly on your website, and also aims to use A/B testing features and SEO automatic optimisation.
 
 ## Visual editor vs CMS
 
 The [Intlayer Visual](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) editor is a tool that allows you to manage your content in a visual editor for local dictionaries. Once a change is made, the content will be replaced in the code-base. This means that the application will be rebuilt and the page will be reloaded to display the new content.
 
-In contrast, the Intlayer CMS is a tool that allows you to manage your content in a visual editor for distant dictionaries. Once a change is made, the content will **not** impact your code-base. The website will automatically display the updated content.
+In contrast, the Intlayer CMS is a tool that allows you to manage your content in a visual editor for remote dictionaries. Once a change is made, the content will **not** impact your code-base. The website will automatically display the updated content.
 
 ## Integrating
 
@@ -520,11 +530,3 @@ If you encounter any issues with the CMS, check the following:
 - Ensure that the project configuration was pushed to the Intlayer CMS.
 
 - The visual editor uses an iframe to display your website. Ensure that the Content Security Policy (CSP) of your website allows the CMS URL as `frame-ancestors` ('https://intlayer.org' by default). Check the editor console for any errors.
-
-## Doc History
-
-| Version | Date       | Changes                                   |
-| ------- | ---------- | ----------------------------------------- |
-| 6.0.1   | 2025-09-22 | Add live sync documentation               |
-| 6.0.0   | 2025-09-04 | Replace `hotReload` field with `liveSync` |
-| 5.5.10  | 2025-06-29 | Initialise history                        |

package/docs/en-GB/intlayer_cli.md

@@ -16,6 +16,13 @@ slugs:
   - doc
   - concept
   - cli
+history:
+  - version: 5.5.11
+    date: 2025-07-11
+    changes: Update CLI command parameters documentation
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Intlayer CLI
@@ -565,10 +572,3 @@ Sometimes a terminal restart is needed to recognise new commands.
 ```bash
 npx clear-npx-cache
 ```
-
-## Doc History
-
-| Version | Date       | Changes                                     |
-| ------- | ---------- | ------------------------------------------- |
-| 5.5.11  | 2025-07-11 | Update CLI command parameters documentation |
-| 5.5.10  | 2025-06-29 | Init history                                |

package/docs/en-GB/intlayer_visual_editor.md

@@ -16,6 +16,10 @@ slugs:
   - concept
   - editor
 youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Intlayer Visual Editor Documentation
@@ -24,7 +28,7 @@ youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
 
 The Intlayer Visual Editor is a tool that will wrap your website to interact with your content declaration files using a visual editor.
 
-![Intlayer Visual Editor Interface](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.gif)
+![Intlayer Visual Editor Interface](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.gif?raw=true)
 
 The `intlayer-editor` package is based on Intlayer and is available for JavaScript applications, such as React (Create React App), Vite + React, and Next.js.
 
@@ -257,12 +261,7 @@ 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 is correctly set in your Intlayer configuration file.
-
   - Required fields:
     - The application URL should match the one you set in the editor configuration (`applicationURL`).
 
 - The visual editor uses an iframe to display your website. Ensure that the Content Security Policy (CSP) of your website allows the CMS URL as `frame-ancestors` ('http://localhost:8000' by default). Check the editor console for any error.
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

package/docs/en-GB/intlayer_with_angular.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-04-18
 updatedAt: 2025-06-29
-title: Translate your Angular website (i18n)
+title: How to translate your Angular app – i18n guide 2025
 description: Discover how to make your Angular website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalization
@@ -14,6 +14,10 @@ slugs:
   - environment
   - angular
 # applicationTemplate: https://github.com/aymericzip/intlayer-angular-template
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Init history
 ---
 
 # Getting Started with Internationalisation (i18n) in Angular using Intlayer
@@ -310,7 +314,7 @@ export default appContent;
 
 > Your content declarations can be defined anywhere in your application as soon they are included into the `contentDir` directory (by default, `./src`). And match the content declaration file extension (by default, `.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}`).
 
-> For more details, refer to the [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/get_started.md).
+> For more details, refer to the [content declaration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md).
 
 ### Step 5: Utilize Intlayer in Your Code
 
@@ -663,9 +667,9 @@ For more complex scenarios, you can create a pipe to safely render the HTML.
 
 Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.
 
-![alt text](https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png)
+![Autocompletion](https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true)
 
-![alt text](https://github.com/aymericzip/intlayer/blob/main/docs/assets/translation_error.png)
+![Translation error](https://github.com/aymericzip/intlayer/blob/main/docs/assets/translation_error.png?raw=true)
 
 Ensure your TypeScript configuration includes the autogenerated types.
 
@@ -739,7 +743,3 @@ For more details on how to use the extension, refer to the [Intlayer VS Code Ext
 To go further, you can implement the [visual editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) or externalise your content using the [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_CMS.md).
 
 ---
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history