@intlayer/docs 8.1.0 → 8.1.2

package/docs/ar/packages/next-intlayer.md

@@ -1,70 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: "توثيق حزمة next-intlayer"
-description: "تكامل مخصص لـ Next.js مع Intlayer، يوفر middleware ومزودات لـ App Router و Page Router."
-keywords:
-  - next-intlayer
-  - nextjs
-  - react
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - next-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: "توثيق موحد لجميع exports"
----
-
-# حزمة next-intlayer
-
-توفر حزمة `next-intlayer` الأدوات اللازمة لدمج Intlayer في تطبيقات Next.js. تدعم الحزمة كلًا من App Router و Page Router، بما في ذلك middleware للتوجيه بناءً على اللغة.
-
-## التثبيت
-
-```bash
-npm install next-intlayer
-```
-
-## التصديرات
-
-### الوسيط (Middleware)
-
-| الدالة               | الوصف                                                                  |
-| -------------------- | ---------------------------------------------------------------------- |
-| `intlayerMiddleware` | Middleware لـ Next.js لمعالجة التوجيه القائم على اللغة وإعادة التوجيه. |
-
-### المزودون
-
-| المكون                   | الوصف                                                  |
-| ------------------------ | ------------------------------------------------------ |
-| `IntlayerClientProvider` | مزود للمكونات على جانب العميل في Next.js.              |
-| `IntlayerServerProvider` | مزود للمكونات على جانب الخادم في Next.js (App Router). |
-
-### Hooks (جانب العميل)
-
-يعيد تصدير معظم الـ hooks من `react-intlayer`.
-
-| Hook            | الوصف                                              |
-| --------------- | -------------------------------------------------- |
-| `useIntlayer`   | يختار قاموسًا واحدًا بواسطة مفتاحه ويُرجع المحتوى. |
-| `useDictionary` | يختار قاموسًا واحدًا بواسطة مفتاحه ويُرجع المحتوى. |
-| `useLocale`     | يعيد الـ locale الحالي ودالة لتعيينه.              |
-| `useI18n`       | يعيد قيم سياق Intlayer الحالية.                    |
-
-### الدوال (جهة الخادم)
-
-| الدالة                 | الوصف                                                                   |
-| ---------------------- | ----------------------------------------------------------------------- |
-| `t`                    | نسخة الخادم من دالة الترجمة لـ Next.js App Router.                      |
-| `generateStaticParams` | يولّد معلمات ثابتة (static parameters) للمسارات الديناميكية في Next.js. |
-
-### الأنواع
-
-| النوع                | الوصف                                              |
-| -------------------- | -------------------------------------------------- |
-| `NextPageIntlayer`   | نوع لصفحات Next.js التي تدعم Intlayer.             |
-| `NextLayoutIntlayer` | نوع لتخطيطات (layouts) Next.js التي تدعم Intlayer. |

package/docs/ar/packages/vue-intlayer.md

@@ -1,59 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: توثيق حزمة vue-intlayer
-description: تكامل مخصّص لـ Vue مع Intlayer، يوفر مكوّنات إضافية (plugins) وcomposables لتطبيقات Vue.
-keywords:
-  - vue-intlayer
-  - vue
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - vue-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: توحيد التوثيق لجميع الصادرات
----
-
-# حزمة vue-intlayer
-
-توفّر حزمة `vue-intlayer` الأدوات اللازمة لدمج Intlayer في تطبيقات Vue. تتضمن مكوّنًا إضافيًا لـ Vue وcomposables للتعامل مع المحتوى متعدد اللغات.
-
-## التثبيت
-
-```bash
-npm install vue-intlayer
-```
-
-## الصادرات
-
-### المكوّن الإضافي
-
-| الدالة            | الوصف                                |
-| ----------------- | ------------------------------------ |
-| `installIntlayer` | مكوّن Vue لتثبيت Intlayer في تطبيقك. |
-
-### القوالب القابلة لإعادة الاستخدام (Composables)
-
-| قابل للتركيب    | الوصف                                             |
-| --------------- | ------------------------------------------------- |
-| `useIntlayer`   | يختار قاموسًا واحدًا بواسطة مفتاحه ويعيد المحتوى. |
-| `useDictionary` | يختار قاموسًا واحدًا بواسطة مفتاحه ويعيد المحتوى. |
-| `useLocale`     | يعيد الـ locale الحالي ودالة لتعيينه.             |
-| `useIntl`       | يعيد كائن Intl للـ locale الحالي.                 |
-
-### الدوال
-
-| دالة            | الوصف                    |
-| --------------- | ------------------------ |
-| `getDictionary` | يسترجع قاموسًا.          |
-| `getIntlayer`   | يسترجع المحتوى من قاموس. |
-
-### ماركداون
-
-| الدالة                    | الوصف                                         |
-| ------------------------- | --------------------------------------------- |
-| `installIntlayerMarkdown` | إضافة Vue لتثبيت Intlayer Markdown في تطبيقك. |

package/docs/de/packages/angular-intlayer.md

@@ -1,50 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: Dokumentation des Pakets angular-intlayer
-description: Angular-spezifische Integration für Intlayer, die Provider und Services für Angular-Anwendungen bereitstellt.
-keywords:
-  - angular-intlayer
-  - angular
-  - Internationalisierung
-  - i18n
-slugs:
-  - doc
-  - packages
-  - angular-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Vereinheitlichte Dokumentation für alle Exporte
----
-
-# Paket angular-intlayer
-
-Das Paket `angular-intlayer` stellt die notwendigen Werkzeuge bereit, um Intlayer in Angular-Anwendungen zu integrieren. Es enthält Provider und Services zur Handhabung mehrsprachiger Inhalte.
-
-## Installation
-
-```bash
-npm install angular-intlayer
-```
-
-## Exporte
-
-### Einrichtung
-
-| Funktion          | Beschreibung                                                      |
-| ----------------- | ----------------------------------------------------------------- |
-| `provideIntlayer` | Funktion, um Intlayer in Ihrer Angular-Anwendung bereitzustellen. |
-
-### Dienste
-
-| Service           | Beschreibung                                                                                     |
-| ----------------- | ------------------------------------------------------------------------------------------------ |
-| `IntlayerService` | Service, der ein Wörterbuch anhand seines Schlüssels auswählt und den Inhalt zurückgibt.         |
-| `LocaleService`   | Service, der die aktuelle Locale zurückgibt und eine Funktion zum Setzen derselben bereitstellt. |
-
-### Komponenten
-
-| Komponente                  | Beschreibung                                      |
-| --------------------------- | ------------------------------------------------- |
-| `IntlayerMarkdownComponent` | Angular-Komponente, die Markdown-Inhalte rendert. |

package/docs/de/packages/astro-intlayer.md

@@ -1,37 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: Dokumentation des astro-intlayer-Pakets
-description: Astro-Integration für Intlayer, die die Einrichtung von lokalisierungsbasiertem Routing und Wörterbuchverwaltung bereitstellt.
-keywords:
-  - astro-intlayer
-  - astro
-  - Internationalisierung
-  - i18n
-slugs:
-  - doc
-  - packages
-  - astro-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Vereinheitlichte Dokumentation für alle Exporte
----
-
-# astro-intlayer Paket
-
-Das `astro-intlayer` Paket stellt die notwendigen Werkzeuge bereit, um Intlayer in Astro-Anwendungen zu integrieren. Es konfiguriert lokalisierungsbasiertes Routing und die Verwaltung von Wörterbüchern.
-
-## Installation
-
-```bash
-npm install astro-intlayer
-```
-
-## Exporte
-
-### Integration
-
-| Funktion   | Beschreibung                                                 |
-| ---------- | ------------------------------------------------------------ |
-| `intlayer` | Astro-Integration, die Intlayer in Ihrem Projekt einrichtet. |

package/docs/de/packages/intlayer-cli.md

@@ -1,46 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: intlayer-cli Paketdokumentation
-description: CLI-Tool für Intlayer, das Befehle zum Erstellen und Auditieren von Wörterbüchern bereitstellt.
-keywords:
-  - intlayer-cli
-  - cli
-  - tools
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - intlayer-cli
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# intlayer-cli Paket
-
-Das `intlayer-cli`-Paket stellt eine Reihe von Befehlen zur Verwaltung von Intlayer-Wörterbüchern und -Konfiguration bereit.
-
-## Installation
-
-```bash
-npm install intlayer-cli
-```
-
-## Exporte
-
-### CLI-Befehle (Funktionen)
-
-Das Paket exportiert Funktionen, die die CLI-Befehle ausführen.
-
-| Funktion   | Beschreibung                                        |
-| ---------- | --------------------------------------------------- |
-| `build`    | Erstellt die Intlayer-Dictionaries.                 |
-| `audit`    | Prüft die Dictionaries auf fehlende Übersetzungen.  |
-| `liveSync` | Synchronisiert Dictionaries in Echtzeit.            |
-| `pull`     | Lädt Dictionaries von einer Remote-Quelle herunter. |
-| `push`     | Überträgt Dictionaries zu einer Remote-Quelle.      |
-| `test`     | Führt Tests für Dictionaries aus.                   |
-| `extract`  | Transformiert Dictionaries zwischen Formaten.       |

package/docs/de/packages/next-intlayer.md

@@ -1,70 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: next-intlayer Paketdokumentation
-description: Next.js-spezifische Integration für Intlayer, die Middleware und Provider für App Router und Page Router bereitstellt.
-keywords:
-  - next-intlayer
-  - nextjs
-  - react
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - next-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# next-intlayer Paket
-
-Das `next-intlayer`-Paket stellt die notwendigen Werkzeuge zur Integration von Intlayer in Next.js-Anwendungen bereit. Es unterstützt sowohl den App Router als auch den Page Router und enthält Middleware für auf Locale basierendes Routing.
-
-## Installation
-
-```bash
-npm install next-intlayer
-```
-
-## Exports
-
-### Middleware
-
-| Funktion             | Beschreibung                                                                |
-| -------------------- | --------------------------------------------------------------------------- |
-| `intlayerMiddleware` | Next.js-Middleware für lokalisierungsbasiertes Routing und Weiterleitungen. |
-
-### Provider
-
-| Komponente               | Beschreibung                                                    |
-| ------------------------ | --------------------------------------------------------------- |
-| `IntlayerClientProvider` | Provider für clientseitige Komponenten in Next.js.              |
-| `IntlayerServerProvider` | Provider für serverseitige Komponenten in Next.js (App Router). |
-
-### Hooks (Client-seitig)
-
-Re-exportiert die meisten Hooks aus `react-intlayer`.
-
-| Hook            | Beschreibung                                                                  |
-| --------------- | ----------------------------------------------------------------------------- |
-| `useIntlayer`   | Wählt ein Wörterbuch anhand seines Schlüssels aus und gibt den Inhalt zurück. |
-| `useDictionary` | Wählt ein Wörterbuch anhand seines Schlüssels aus und gibt den Inhalt zurück. |
-| `useLocale`     | Gibt die aktuelle Locale und eine Funktion zum Setzen derselben zurück.       |
-| `useI18n`       | Gibt die aktuellen Intlayer-Kontextwerte zurück.                              |
-
-### Funktionen (Server-seitig)
-
-| Funktion               | Beschreibung                                                               |
-| ---------------------- | -------------------------------------------------------------------------- |
-| `t`                    | Serverseitige Version der Übersetzungsfunktion für den Next.js App Router. |
-| `generateStaticParams` | Generiert statische Parameter für die dynamischen Routen von Next.js.      |
-
-### Typen
-
-| Type                 | Beschreibung                                        |
-| -------------------- | --------------------------------------------------- |
-| `NextPageIntlayer`   | Typ für Next.js-Seiten mit Intlayer-Unterstützung.  |
-| `NextLayoutIntlayer` | Typ für Next.js-Layouts mit Intlayer-Unterstützung. |

package/docs/de/packages/vue-intlayer.md

@@ -1,59 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: vue-intlayer Paketdokumentation
-description: Vue-spezifische Integration für Intlayer, die Plugins und Composables für Vue-Anwendungen bereitstellt.
-keywords:
-  - vue-intlayer
-  - vue
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - vue-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Einheitliche Dokumentation für alle Exporte
----
-
-# vue-intlayer Paket
-
-Das `vue-intlayer`-Paket stellt die notwendigen Werkzeuge zur Integration von Intlayer in Vue-Anwendungen bereit. Es enthält ein Vue-Plugin und Composables zur Verwaltung mehrsprachiger Inhalte.
-
-## Installation
-
-```bash
-npm install vue-intlayer
-```
-
-## Exports
-
-### Plugin
-
-| Funktion          | Beschreibung                                                |
-| ----------------- | ----------------------------------------------------------- |
-| `installIntlayer` | Vue-Plugin, um Intlayer in Ihrer Anwendung zu installieren. |
-
-### Composables
-
-| Composable      | Beschreibung                                                                        |
-| --------------- | ----------------------------------------------------------------------------------- |
-| `useIntlayer`   | Wählt ein Wörterbuch anhand seines Schlüssels aus und gibt den Inhalt zurück.       |
-| `useDictionary` | Wählt ein Wörterbuch anhand seines Schlüssels aus und gibt den Inhalt zurück.       |
-| `useLocale`     | Gibt die aktuelle Locale und eine Funktion zurück, mit der sie gesetzt werden kann. |
-| `useIntl`       | Gibt das Intl-Objekt für die aktuelle Locale zurück.                                |
-
-### Funktionen
-
-| Funktion        | Beschreibung                          |
-| --------------- | ------------------------------------- |
-| `getDictionary` | Ruft ein Wörterbuch ab.               |
-| `getIntlayer`   | Ruft Inhalte aus einem Wörterbuch ab. |
-
-### Markdown
-
-| Funktion                  | Beschreibung                                                         |
-| ------------------------- | -------------------------------------------------------------------- |
-| `installIntlayerMarkdown` | Vue-Plugin, um Intlayer Markdown in Ihrer Anwendung zu installieren. |

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

@@ -1,50 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: angular-intlayer Package Documentation
-description: Angular-specific integration for Intlayer, providing providers and services for Angular applications.
-keywords:
-  - angular-intlayer
-  - angular
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - angular-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# angular-intlayer Package
-
-The `angular-intlayer` package provides the necessary tools to integrate Intlayer into Angular applications. It includes providers and services for handling multilingual content.
-
-## Installation
-
-```bash
-npm install angular-intlayer
-```
-
-## Exports
-
-### Setup
-
-| Function          | Description                                               |
-| ----------------- | --------------------------------------------------------- |
-| `provideIntlayer` | Function to provide Intlayer in your Angular application. |
-
-### Services
-
-| Service           | Description                                                            |
-| ----------------- | ---------------------------------------------------------------------- |
-| `IntlayerService` | Service that picking one dictionary by its key and return the content. |
-| `LocaleService`   | Service that returns the current locale and a function to set it.      |
-
-### Components
-
-| Component                   | Description                                      |
-| --------------------------- | ------------------------------------------------ |
-| `IntlayerMarkdownComponent` | Angular component that renders markdown content. |

package/docs/en/packages/astro-intlayer.md

@@ -1,37 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: astro-intlayer Package Documentation
-description: Astro integration for Intlayer, providing setup for locale-based routing and dictionary management.
-keywords:
-  - astro-intlayer
-  - astro
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - astro-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# astro-intlayer Package
-
-The `astro-intlayer` package provides the necessary tools to integrate Intlayer into Astro applications. It configures locale-based routing and dictionary management.
-
-## Installation
-
-```bash
-npm install astro-intlayer
-```
-
-## Exports
-
-### Integration
-
-| Function   | Description                                              |
-| ---------- | -------------------------------------------------------- |
-| `intlayer` | Astro integration that sets up Intlayer in your project. |

package/docs/en/packages/intlayer-cli.md

@@ -1,46 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: intlayer-cli Package Documentation
-description: CLI tool for Intlayer, providing commands for building and auditing dictionaries.
-keywords:
-  - intlayer-cli
-  - cli
-  - tools
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - intlayer-cli
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# intlayer-cli Package
-
-The `intlayer-cli` package provides a set of commands to manage Intlayer dictionaries and configuration.
-
-## Installation
-
-```bash
-npm install intlayer-cli
-```
-
-## Exports
-
-### CLI Commands (Functions)
-
-The package exports functions that power the CLI commands.
-
-| Function   | Description                                           |
-| ---------- | ----------------------------------------------------- |
-| `build`    | Builds the Intlayer dictionaries.                     |
-| `audit`    | Audits the dictionaries for missing translations.     |
-| `liveSync` | Synchronizes dictionaries in real-time.               |
-| `pull`     | Pulls dictionaries from a remote source.              |
-| `push`     | Pushes dictionaries to a remote source.               |
-| `test`     | Runs tests on dictionaries.                           |
-| `extract`  | Extract strings from components into a .content file. |

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

@@ -1,70 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: next-intlayer Package Documentation
-description: Next.js-specific integration for Intlayer, providing middleware and providers for App Router and Page Router.
-keywords:
-  - next-intlayer
-  - nextjs
-  - react
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - next-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# next-intlayer Package
-
-The `next-intlayer` package provides the necessary tools to integrate Intlayer into Next.js applications. It supports both the App Router and the Page Router, including middleware for locale-based routing.
-
-## Installation
-
-```bash
-npm install next-intlayer
-```
-
-## Exports
-
-### Middleware
-
-| Function             | Description                                                      |
-| -------------------- | ---------------------------------------------------------------- |
-| `intlayerMiddleware` | Next.js middleware to handle locale-based routing and redirects. |
-
-### Providers
-
-| Component                | Description                                                  |
-| ------------------------ | ------------------------------------------------------------ |
-| `IntlayerClientProvider` | Provider for client-side components in Next.js.              |
-| `IntlayerServerProvider` | Provider for server-side components in Next.js (App Router). |
-
-### Hooks (Client-side)
-
-Re-exports most hooks from `react-intlayer`.
-
-| Hook            | Description                                              |
-| --------------- | -------------------------------------------------------- |
-| `useIntlayer`   | Picks one dictionary by its key and returns the content. |
-| `useDictionary` | Picks one dictionary by its key and returns the content. |
-| `useLocale`     | Returns the current locale and a function to set it.     |
-| `useI18n`       | Returns the current Intlayer context values.             |
-
-### Functions (Server-side)
-
-| Function               | Description                                                             |
-| ---------------------- | ----------------------------------------------------------------------- |
-| `t`                    | Server-side version of the translation function for Next.js App Router. |
-| `generateStaticParams` | Generates static parameters for Next.js's dynamic routes.               |
-
-### Types
-
-| Type                 | Description                                     |
-| -------------------- | ----------------------------------------------- |
-| `NextPageIntlayer`   | Type for Next.js pages with Intlayer support.   |
-| `NextLayoutIntlayer` | Type for Next.js layouts with Intlayer support. |

package/docs/en/packages/vue-intlayer.md

@@ -1,59 +0,0 @@
----
-createdAt: 2026-01-21
-updatedAt: 2026-01-21
-title: vue-intlayer Package Documentation
-description: Vue-specific integration for Intlayer, providing plugins and composables for Vue applications.
-keywords:
-  - vue-intlayer
-  - vue
-  - internationalization
-  - i18n
-slugs:
-  - doc
-  - packages
-  - vue-intlayer
-history:
-  - version: 8.0.0
-    date: 2026-01-21
-    changes: Unified documentation for all exports
----
-
-# vue-intlayer Package
-
-The `vue-intlayer` package provides the necessary tools to integrate Intlayer into Vue applications. It includes a Vue plugin and composables for handling multilingual content.
-
-## Installation
-
-```bash
-npm install vue-intlayer
-```
-
-## Exports
-
-### Plugin
-
-| Function          | Description                                         |
-| ----------------- | --------------------------------------------------- |
-| `installIntlayer` | Vue plugin to install Intlayer in your application. |
-
-### Composables
-
-| Composable      | Description                                              |
-| --------------- | -------------------------------------------------------- |
-| `useIntlayer`   | Picks one dictionary by its key and returns the content. |
-| `useDictionary` | Picks one dictionary by its key and returns the content. |
-| `useLocale`     | Returns the current locale and a function to set it.     |
-| `useIntl`       | Returns the Intl object for the current locale.          |
-
-### Functions
-
-| Function        | Description                          |
-| --------------- | ------------------------------------ |
-| `getDictionary` | Retrieves a dictionary.              |
-| `getIntlayer`   | Retrieves content from a dictionary. |
-
-### Markdown
-
-| Function                  | Description                                                  |
-| ------------------------- | ------------------------------------------------------------ |
-| `installIntlayerMarkdown` | Vue plugin to install Intlayer Markdown in your application. |