@intlayer/docs 6.0.2-canary.0 → 6.1.0

package/docs/en-GB/packages/@intlayer/api/index.md

@@ -1,56 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/api - SDK for Intlayer API Integration
-description: NPM package providing Software Development Kit (SDK) to interact with Intlayer API for content auditing, organisations, projects, and user management.
-keywords:
-  - intlayer
-  - API
-  - SDK
-  - integration
-  - content audit
-  - organisations
-  - projects
-  - JavaScript
-slugs:
-  - doc
-  - packages
-  - intlayer
-  - api
----
-
-# @intlayer/api: NPM Package to interact with Intlayer API
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
-
-The **`@intlayer/api`** package is an SDK (Software Development Kit) to interact with the Intlayer API. It provides a set of functions to audit content declaration, interact with organisations, projects, and users, etc.
-
-## Usage
-
-```ts
-import { intlayerAPI } from "@intlayer/api";
-
-intlayerAPI.user.getUser({
-  ids: ["user-id-1", "user-id-2"],
-});
-```
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/api
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/api
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/api
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history

package/docs/en-GB/packages/@intlayer/chokidar/index.md

@@ -1,55 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/chokidar - File Watching for Intlayer i18n
-description: NPM package providing file watching capabilities for Intlayer, enabling automatic updates and hot reloading for internationalisation content.
-keywords:
-  - intlayer
-  - chokidar
-  - file watching
-  - hot reload
-  - i18n
-  - JavaScript
-  - NPM
-  - development
-slugs:
-  - doc
-  - package
-  - @intlayer_chokidar
----
-
-# @intlayer/chokidar: NPM Package to Scan and Build Intlayer Declaration Files into Dictionaries
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React and Express.js.
-
-The **`@intlayer/chokidar`** package is used to scan and build Intlayer declaration files into dictionaries using [chokidar](https://github.com/paulmillr/chokidar) and in accordance with the [Intlayer configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md).
-
-## Usage
-
-```ts
-import { watch, prepareIntlayer } from "@intlayer/chokidar";
-
-await prepareIntlayer(); // Build Intlayer dictionaries
-
-watch({ persistent: true }); // Watch for changes in the configuration files
-```
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/chokidar
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/chokidar
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/chokidar
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/cli/index.md

@@ -1,45 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/cli - Command Line Interface Package for Intlayer
-description: NPM package providing scripts for Intlayer CLI commands, ensuring uniformity across all command line interfaces for internationalisation management.
-keywords:
-  - intlayer
-  - CLI
-  - command line
-  - scripts
-  - i18n
-  - JavaScript
-  - NPM
-  - tools
-slugs:
-  - doc
-  - package
-  - @intlayer_cli
----
-
-# @intlayer/cli: NPM Package to use the scripts provided by the intlayer CLI
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React, React, and Express.js.
-
-The **`@intlayer/cli`** package is an NPM package used to declare the scripts related to the Intlayer command line interfaces. It ensures the uniformity of all Intlayer CLI commands. This package is notably consumed by the [intlayer-cli](https://github.com/aymericzip/intlayer/tree/main/docs/docs/en-GB/packages/intlayer-cli/index.md), and the [intlayer](https://github.com/aymericzip/intlayer/tree/main/docs/docs/en-GB/packages/intlayer/index.md) packages.
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/cli
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/cli
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/cli
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/config/index.md

@@ -1,140 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/config - Configuration Management for Intlayer
-description: NPM package to retrieve Intlayer configuration and define environment variables for internationalisation settings across different environments.
-keywords:
-  - intlayer
-  - configuration
-  - environment
-  - settings
-  - i18n
-  - JavaScript
-  - NPM
-  - variables
-slugs:
-  - doc
-  - package
-  - @intlayer_config
----
-
-# @intlayer/config: NPM Package to retrieve Intlayer configuration
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React, React, and Express.js.
-
-The **`@intlayer/config`** package is an NPM package that allows you to retrieve the configuration of Intlayer and define the environment variables related to the current environment.
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/config
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/config
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/config
-```
-
-## Usage
-
-### Read the configuration of Intlayer using the file system
-
-Example:
-
-```ts
-import { getConfiguration, type IntlayerConfig } from "@intlayer/config";
-
-const config: IntlayerConfig = getConfiguration();
-
-console.log(config);
-// Output:
-// {
-//   internationalisation: { ... },
-//   middleware: { ... },
-//   content: { ... },
-//   editor: { ... }
-// }
-```
-
-> This function uses the `fs` package and will only work on the server side.
-
-### Read the configuration of Intlayer using environment variables
-
-Example:
-
-```ts
-import { getConfiguration, type IntlayerConfig } from "@intlayer/config/client";
-
-const config: IntlayerConfig = getConfiguration({
-  env: "production",
-});
-
-console.log(config);
-// Output:
-// {
-//   internationalisation: { ... },
-//   middleware: { ... },
-//   content: { ... },
-//   editor: { ... }
-// }
-```
-
-> This function will not return anything if the environment variables are not defined.
-
-### Define the environment variables
-
-1. Create a configuration file.
-
-```ts fileName="intlayer.config.ts"
-import { type IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  internationalisation: {
-    /* ... */
-  },
-  middleware: {
-    /* ... */
-  },
-  content: {
-    /* ... */
-  },
-  editor: {
-    /* ... */
-  },
-};
-
-export default config;
-```
-
-> See [Intlayer configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md) for more details.
-
-2. Define the environment variables.
-
-```ts
-import { getConfiguration } from "@intlayer/config";
-
-const intlayerConfig = getConfiguration();
-
-// Format all configuration values as environment variables
-const env = formatEnvVariable();
-
-// Set each formatted environment variable in process.env
-Object.assign(process.env, env);
-```
-
-3. Import the configuration file.
-
-```ts
-import { getConfiguration } from "@intlayer/config/client";
-
-const intlayerConfig = getConfiguration();
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/core/index.md

@@ -1,49 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/core - Core Functions for Intlayer i18n
-description: NPM package containing core functions for Intlayer, including translation functions, dictionary functions, and utility functions for internationalisation.
-keywords:
-  - intlayer
-  - core
-  - translation
-  - dictionary
-  - utilities
-  - i18n
-  - JavaScript
-  - NPM
-slugs:
-  - doc
-  - package
-  - @intlayer_core
----
-
-# @intlayer/core: NPM Package containing Intlayer core functions
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
-
-The **`@intlayer/core`** package is an NPM package including core functions of Intlayer shared by multiple packages. It notably includes:
-
-- Translation functions
-- Dictionary functions
-- Utility functions
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/core
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/core
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/core
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/design-system/index.md

@@ -1,45 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/design-system - UI Components for Intlayer
-description: NPM package containing design system components and UI elements for building consistent user interfaces with Intlayer internationalisation.
-keywords:
-  - intlayer
-  - design system
-  - UI components
-  - interface
-  - i18n
-  - JavaScript
-  - NPM
-  - styling
-slugs:
-  - doc
-  - package
-  - @intlayer_design-system
----
-
-# @intlayer/design-system: NPM Package containing the UI library of Intlayer
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React, React, and Express.js.
-
-The **`@intlayer/design-system`** package is an NPM package that includes the design system of Intlayer. This package is notably used by the [Intlayer editor](https://github.com/aymericzip/intlayer/tree/main/docs/docs/en-GB/packages/intlayer-editor/index.md), on the [Website](https://intlayer.org) and the [Visual Editor / CMS](https://intlayer.org/dashboard).
-
-## Installation
-
-Install the required package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/design-system
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/design-system
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/design-system
-```
-
-## Doc History
-
-- 5.5.10 - 29-06-2025: Initial history

package/docs/en-GB/packages/@intlayer/dictionary-entry/index.md

@@ -1,45 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/dictionary-entry - Dictionary Management for Intlayer
-description: NPM package for managing dictionary entries in Intlayer, providing utilities for creating, updating, and organising translation dictionaries.
-keywords:
-  - intlayer
-  - dictionary
-  - entries
-  - management
-  - translation
-  - i18n
-  - JavaScript
-  - NPM
-slugs:
-  - doc
-  - package
-  - @intlayer_dictionary-entry
----
-
-# @intlayer/dictionary-entry: NPM Package to retrieve Intlayer dictionaries
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
-
-The **`@intlayer/dictionary-entry`** package is an NPM package that only returns the entry path of the Intlayer dictionaries. Since filesystem search is impossible from the browser, using bundlers like Webpack or Rollup to retrieve the entry path of the dictionaries is not possible. This package is intended to be aliased.
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/dictionary-entry
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/dictionary-entry
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/dictionary-entry
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initialise history

package/docs/en-GB/packages/@intlayer/editor/index.md

@@ -1,45 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/editor - Intlayer Editor Interface Package
-description: NPM package providing utilities to interface applications with the Intlayer editor and manipulate dictionaries across all JavaScript frameworks.
-keywords:
-  - intlayer
-  - editor
-  - dictionary
-  - interface
-  - NPM
-  - JavaScript
-  - utilities
-  - cross-platform
-slugs:
-  - doc
-  - package
-  - @intlayer_editor
----
-
-# @intlayer/editor: NPM Package providing utilities to interface the application with the Intlayer editor and manipulate dictionaries
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React, Next.js, and Express.js.
-
-The **`intlayer-editor`** package provides utilities to interface the application with the Intlayer editor. It includes the API to interact with the editor, and utilities to manipulate dictionaries. This package is cross-platform.
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash
-npm install @intlayer/editor
-```
-
-```bash
-yarn add @intlayer/editor
-```
-
-```bash
-pnpm add @intlayer/editor
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/editor-react/index.md

@@ -1,45 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/editor-react - React Components for Intlayer Editor
-description: NPM package providing React components and hooks for integrating the Intlayer visual editor into React applications for internationalisation.
-keywords:
-  - intlayer
-  - editor
-  - React
-  - components
-  - hooks
-  - i18n
-  - JavaScript
-  - NPM
-slugs:
-  - doc
-  - package
-  - @intlayer_editor-react
----
-
-# @intlayer/editor-react: NPM Package providing React States, Contexts, Hooks and Components to interact with the Intlayer editor
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React, Next.js, and Express.js.
-
-The **`@intlayer/editor-react`** package provides states, contexts, hooks and components to interact with the Intlayer editor within a React application.
-
-## Installation
-
-Install the required package using your preferred package manager:
-
-```bash
-npm install @intlayer/editor-react
-```
-
-```bash
-yarn add @intlayer/editor-react
-```
-
-```bash
-pnpm add @intlayer/editor-react
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/@intlayer/webpack/index.md

@@ -1,60 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: @intlayer/webpack - Webpack Plugin for Intlayer i18n
-description: NPM package providing Webpack configuration and plugin for seamless integration of Intlayer internationalisation with Webpack-based applications.
-keywords:
-  - intlayer
-  - webpack
-  - plugin
-  - configuration
-  - i18n
-  - JavaScript
-  - NPM
-  - bundler
-slugs:
-  - doc
-  - package
-  - @intlayer_webpack
----
-
-# @intlayer/webpack: NPM Package to use the Intlayer Webpack Plugin in your application
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks such as React and Express.js.
-
-The **`@intlayer/webpack`** package provides a Webpack configuration to facilitate working with a Webpack-based application using Intlayer. The package also includes a plugin to integrate into an existing Webpack application.
-
-## Usage
-
-```ts
-import { IntlayerPlugin } from "@intlayer/webpack";
-
-export default {
-  plugins: [
-    new IntlayerPlugin({
-      // Options
-    }),
-  ],
-};
-```
-
-## Installation
-
-Install the required package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install @intlayer/webpack
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/webpack
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/webpack
-yarn add @intlayer/webpack
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Initial history

package/docs/en-GB/packages/angular-intlayer/index.md

@@ -1,53 +0,0 @@
----
-createdAt: 2025-04-18
-updatedAt: 2025-06-29
-title: Package Documentation | angular-intlayer
-description: See how to use the angular-intlayer package
-keywords:
-  - Intlayer
-  - angular-intlayer
-  - Internationalisation
-  - Documentation
-  - JavaScript
-  - Angular
-slugs:
-  - doc
-  - packages
-  - angular-intlayer
----
-
-# angular-intlayer: NPM Package to internationalise (i18n) an Angular application
-
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like Angular, Angular, and Express.js.
-
-**The `angular-intlayer` package** allows you to internationalise your Angular application. It provides context providers and hooks for Angular internationalisation.
-
-## Why Internationalise Your Angular Application?
-
-Internationalising your Angular application is essential for serving a global audience effectively. It allows your application to deliver content and messages in the preferred language of each user. This capability enhances user experience and broadens your application's reach by making it more accessible and relevant to people from different linguistic backgrounds.
-
-## Why integrate Intlayer?
-
-- **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
-- **Type-Safe Environment**: Utilise TypeScript to ensure all your content definitions are precise and free from errors.
-- **Integrated Content Files**: Keep your translations close to their respective components, improving maintainability and clarity.
-
-## Installation
-
-Install the necessary package using your preferred package manager:
-
-```bash packageManager="npm"
-npm install angular-intlayer
-```
-
-```bash packageManager="yarn"
-yarn add angular-intlayer
-```
-
-```bash packageManager="pnpm"
-pnpm add angular-intlayer
-```
-
-## Doc History
-
-- 5.5.10 - 2025-06-29: Init history