@intlayer/docs 9.0.0-canary.3 → 9.0.0-canary.5

package/docs/de/migration_from_next-intl_to_intlayer.md

@@ -97,24 +97,40 @@ Die folgenden Schritte sind das Minimum, das erforderlich ist, um Ihre bestehend
 
 Installieren Sie die Intlayer-Kernpakete und den Kompatibilitätsadapter `@intlayer/next-intl`:
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> Das Flag `--interactive` ist optional. Verwenden Sie `intlayer-cli init`, wenn Sie ein KI-Agent sind.
+
+> Dieser Befehl erkennt Ihre Umgebung und installiert die erforderlichen Pakete. Zum Beispiel:
+
 ```bash packageManager="npm"
 npm install intlayer next-intlayer @intlayer/next-intl @intlayer/sync-json-plugin
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer next-intlayer @intlayer/next-intl @intlayer/sync-json-plugin
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer next-intlayer @intlayer/next-intl @intlayer/sync-json-plugin
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer next-intlayer @intlayer/next-intl @intlayer/sync-json-plugin
-bun x intlayer init
 ```
 
 > Behalten Sie `next-intl` installiert — es wird weiterhin für **URL-Routing** (`createNavigation`, `createMiddleware`, `Link`, `redirect`, `usePathname`, `useRouter`) benötigt. Der Kompatibilitätsadapter ersetzt die Routing-Schicht **nicht**.

package/docs/de/migration_from_nuxtjs_i18n_to_intlayer.md

@@ -100,24 +100,40 @@ Die folgenden Schritte sind das Minimum, das erforderlich ist, um Ihre bestehend
 
 Installieren Sie die Intlayer-Kernpakete und den Kompatibilitätsadapter:
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> Das Flag `--interactive` ist optional. Verwenden Sie `intlayer-cli init`, wenn Sie ein KI-Agent sind.
+
+> Dieser Befehl erkennt Ihre Umgebung und installiert die erforderlichen Pakete. Zum Beispiel:
+
 ```bash packageManager="npm"
 npm install intlayer vue-intlayer nuxt-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer vue-intlayer nuxt-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer vue-intlayer nuxt-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer vue-intlayer nuxt-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-bun x intlayer init
 ```
 
 > Sie können `@nuxtjs/i18n` während der Migration sicher installiert lassen, obwohl Sie es in Kürze aus Ihrer Nuxt-Konfiguration entfernen werden.

package/docs/de/migration_from_react-i18next_to_intlayer.md

@@ -100,24 +100,40 @@ Die folgenden Schritte sind das Minimum, das erforderlich ist, um Ihre bestehend
 
 Installieren Sie die Intlayer-Kernpakete und die Kompatibilitätsadapter:
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> Das Flag `--interactive` ist optional. Verwenden Sie `intlayer-cli init`, wenn Sie ein KI-Agent sind.
+
+> Dieser Befehl erkennt Ihre Umgebung und installiert die erforderlichen Pakete. Zum Beispiel:
+
 ```bash packageManager="npm"
 npm install intlayer react-intlayer @intlayer/react-i18next @intlayer/i18next @intlayer/sync-json-plugin
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer @intlayer/react-i18next @intlayer/i18next @intlayer/sync-json-plugin
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer @intlayer/react-i18next @intlayer/i18next @intlayer/sync-json-plugin
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer @intlayer/react-i18next @intlayer/i18next @intlayer/sync-json-plugin
-bun x intlayer init
 ```
 
 > Sie können `react-i18next` und `i18next` installiert lassen — die Kompatibilitätsadapter verwenden sie als optionale `devDependencies` / `peerDependencies` für TypeScript-Typen. Sie müssen keine Peers in der `package.json` ändern.

package/docs/de/migration_from_vue-i18n_to_intlayer.md

@@ -99,24 +99,40 @@ Die folgenden Schritte sind das Minimum, das erforderlich ist, um Ihre bestehend
 
 Installieren Sie die Intlayer-Kernpakete und den Kompatibilitätsadapter:
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> Das Flag `--interactive` ist optional. Verwenden Sie `intlayer-cli init`, wenn Sie ein KI-Agent sind.
+
+> Dieser Befehl erkennt Ihre Umgebung und installiert die erforderlichen Pakete. Zum Beispiel:
+
 ```bash packageManager="npm"
 npm install intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer vue-intlayer @intlayer/vue-i18n @intlayer/sync-json-plugin
-bun x intlayer init
 ```
 
 > Sie können `vue-i18n` installiert lassen — der Kompatibilitätsadapter verwendet es als `devDependency` / `peerDependency` für TypeScript-Typen.

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

@@ -14,6 +14,9 @@ slugs:
   - angular-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "usePathname-Dienstprogramm hinzugefügt"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Vereinheitlichte Dokumentation für alle Exporte"
@@ -46,15 +49,16 @@ import "angular-intlayer";
 
 ### Hooks
 
-| Hook                   | Beschreibung                                                                                                                | Zugehöriges Dokument |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------- |
-| `useIntlayer`          | Basierend auf `useDictionary`, injiziert es jedoch eine optimierte Version des Dictionarys aus der generierten Deklaration. | -                    |
-| `useDictionary`        | Verarbeitet Objekte, die wie Dictionaries aussehen (key, content). Verarbeitet `t()`-Übersetzungen, Enumerationen usw.      | -                    |
-| `useDictionaryAsync`   | Wie `useDictionary`, behandelt jedoch asynchrone Dictionaries.                                                              | -                    |
-| `useDictionaryDynamic` | Wie `useDictionary`, behandelt jedoch dynamische Dictionaries.                                                              | -                    |
-| `useLocale`            | Gibt die aktuelle Locale und eine Funktion zurück, um diese zu setzen.                                                      | -                    |
-| `useIntl`              | Gibt das Intl-Objekt für die aktuelle Locale zurück.                                                                        | -                    |
-| `useLoadDynamic`       | Hook zum Laden dynamischer Dictionaries.                                                                                    | -                    |
+| Hook                   | Beschreibung                                                                                                                 | Zugehöriges Dokument                                                                                                  |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | Basierend auf `useDictionary`, injiziert es jedoch eine optimierte Version des Dictionarys aus der generierten Deklaration.  | -                                                                                                                     |
+| `useDictionary`        | Verarbeitet Objekte, die wie Dictionaries aussehen (key, content). Verarbeitet `t()`-Übersetzungen, Enumerationen usw.       | -                                                                                                                     |
+| `useDictionaryAsync`   | Wie `useDictionary`, behandelt jedoch asynchrone Dictionaries.                                                               | -                                                                                                                     |
+| `useDictionaryDynamic` | Wie `useDictionary`, behandelt jedoch dynamische Dictionaries.                                                               | -                                                                                                                     |
+| `useLocale`            | Gibt die aktuelle Locale und eine Funktion zurück, um diese zu setzen.                                                       | -                                                                                                                     |
+| `usePathname`          | Gibt den aktuellen Pfad als `Signal<string>` ohne das Gebietsschema-Segment zurück. Reaktiv auf `popstate` via `DestroyRef`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/angular-intlayer/usePathname.md) |
+| `useIntl`              | Gibt das Intl-Objekt für die aktuelle Locale zurück.                                                                         | -                                                                                                                     |
+| `useLoadDynamic`       | Hook zum Laden dynamischer Dictionaries.                                                                                     | -                                                                                                                     |
 
 ### Komponenten
 

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

@@ -0,0 +1,119 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook Dokumentation | angular-intlayer
+description: Erfahren Sie, wie Sie den usePathname Hook im angular-intlayer Paket verwenden
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisierung
+  - Dokumentation
+  - Angular
+  - JavaScript
+  - TypeScript
+slugs:
+  - doc
+  - packages
+  - angular-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "usePathname-Dienstprogramm hinzugefügt"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Historie initialisiert"
+author: aymericzip
+---
+
+# Angular-Integration: `usePathname` Hook Dokumentation
+
+Der `usePathname`-Hook gibt den aktuellen Browser-Pfad als Angular `Signal<string>` zurück, wobei das Gebietsschema-Segment (Locale) entfernt wurde. Er ist nützlich für den Aufbau einer gebietsschema-basierten Navigation — zum Beispiel, um festzustellen, welches Navigationselement aktiv ist —, ohne das Gebietsschema-Präfix manuell entfernen zu müssen.
+
+## `usePathname` in Angular importieren
+
+```typescript
+import { usePathname } from "angular-intlayer";
+```
+
+## Überblick
+
+`usePathname` liest `window.location.pathname`, entfernt das Gebietsschema-Präfix mittels `getPathWithoutLocale` und aktualisiert das Signal bei jedem `popstate`-Ereignis des Browsers (Zurück-/Vorwärts-Navigation). Er nutzt Angulars `DestroyRef`, um den Event-Listener bei Zerstörung der Komponente automatisch zu entfernen.
+
+## Verwendung
+
+```typescript fileName="src/app/nav-item.component.ts"
+import { Component, input } from "@angular/core";
+import { usePathname } from "angular-intlayer";
+
+@Component({
+  standalone: true,
+  selector: "app-nav-item",
+  template: `
+    <a
+      [href]="href()"
+      [attr.aria-current]="pathname() === href() ? 'page' : null"
+    >
+      {{ label() }}
+    </a>
+  `,
+})
+export class NavItemComponent {
+  readonly href = input.required<string>();
+  readonly label = input.required<string>();
+
+  readonly pathname = usePathname();
+}
+```
+
+## Rückgabewert
+
+| Typ              | Beschreibung                                                                  |
+| ---------------- | ----------------------------------------------------------------------------- |
+| `Signal<string>` | Angular-Signal, das den aktuellen Pfad ohne das Gebietsschema-Präfix enthält. |
+
+## Verhalten
+
+- **Gebietsschema entfernen**: Entfernt das führende Gebietsschema-Segment (z. B. `/de/dashboard` → `/dashboard`).
+- **Reaktiv**: Aktualisiert sich automatisch bei `popstate`-Ereignissen (Zurück-/Vorwärts-Navigation im Browser).
+- **SSR-kompatibel**: Gibt `""` zurück, wenn `window` nicht verfügbar ist.
+- **Bereinigung**: Der `popstate`-Listener wird über `DestroyRef.onDestroy` entfernt, wenn die Host-Komponente zerstört wird.
+
+## Beispiel
+
+```typescript fileName="src/app/sidebar.component.ts"
+import { Component } from "@angular/core";
+import { usePathname } from "angular-intlayer";
+
+@Component({
+  standalone: true,
+  selector: "app-sidebar",
+  template: `
+    <nav>
+      @for (link of links; track link.href) {
+        <a
+          [href]="link.href"
+          [style.font-weight]="pathname() === link.href ? 'bold' : 'normal'"
+        >
+          {{ link.label }}
+        </a>
+      }
+    </nav>
+  `,
+})
+export class SidebarComponent {
+  readonly links = [
+    { href: "/dashboard", label: "Dashboard" },
+    { href: "/settings", label: "Settings" },
+  ];
+
+  readonly pathname = usePathname();
+}
+```
+
+## Verwandt
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/angular-intlayer/exports.md) — aktuelles Gebietsschema + Gebietsschema-Wechsler
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPathWithoutLocale.md) — das von diesem Hook zugrundeliegende genutzte Dienstprogramm

package/docs/de/packages/intlayer/comparePaths.md

@@ -0,0 +1,173 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Dokumentation der Funktion comparePaths | intlayer
+description: Erfahren Sie, wie Sie die Funktion comparePaths für das intlayer-Paket verwenden
+keywords:
+  - comparePaths
+  - normalizePath
+  - aktiver Link
+  - Navigation
+  - Intlayer
+  - intlayer
+  - Internationalisierung
+  - Dokumentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - comparePaths
+history:
+  - version: 9.0.0
+    date: 2026-06-22
+    changes: "Initiale Dokumentation"
+author: aymericzip
+---
+
+# Dokumentation: Funktion `comparePaths` in `intlayer`
+
+## Beschreibung
+
+Die Funktion `comparePaths` vergleicht zwei URLs oder Pfade auf Gleichheit und ignoriert dabei das Locale-Segment, das Protokoll/den Host, die Suchanfrage (Query-String), den Hash und abschließende Schrägstriche (Trailing Slashes). Dies ist die empfohlene Methode, um festzustellen, ob ein Navigationslink auf die aktuelle Seite verweist — beispielsweise um den aktiven Link hervorzuheben —, ohne dass Sie eine eigene (fehleranfällige) Normalisierungslogik erstellen müssen.
+
+Intern verwendet sie [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPathWithoutLocale.md), um das Locale-Segment zu entfernen, sodass Ihr konfiguriertes Routing-Verfahren und Ihre Locales berücksichtigt werden.
+
+Das Paket exportiert auch den zugrundeliegenden Helper [`normalizePath`](#normalizepath), der den kanonischen, Locale-unabhängigen Pfad für den Vergleich zurückgibt.
+
+**Hauptmerkmale:**
+
+- Locale-unabhängiger Vergleich (`/de/about` entspricht `/about`)
+- Funktioniert sowohl mit absoluten URLs als auch mit relativen Pfaden
+- Ignoriert Query-Strings, Hashes und abschließende Schrägstriche
+- Toleriert fehlende führende Schrägstriche und leere Werte (normalisiert zu `/`)
+- Leichtgewichtig — baut auf `getPathWithoutLocale` auf
+
+---
+
+## Funktionssignatur
+
+```typescript
+comparePaths(
+  pathname: string,  // Erforderlich
+  href: string,      // Erforderlich
+  locales?: Locales[] // Optional
+): boolean
+
+normalizePath(
+  inputUrl: string,   // Erforderlich
+  locales?: Locales[] // Optional
+): string
+```
+
+---
+
+## Parameter
+
+- `pathname: string`
+  - **Beschreibung**: Der erste zu vergleichende URL-String oder Pfad (üblicherweise der aktuelle Pfad).
+  - **Typ**: `string`
+  - **Erforderlich**: Ja
+
+- `href: string`
+  - **Beschreibung**: Der zweite zu vergleichende URL-String oder Pfad (üblicherweise das `href` eines Navigationslinks).
+  - **Typ**: `string`
+  - **Erforderlich**: Ja
+
+- `locales: Locales[]`
+  - **Beschreibung**: Optionales Array unterstützter Locales. Standardmäßig die im Projekt konfigurierten Locales.
+  - **Typ**: `Locales[]`
+  - **Erforderlich**: Nein (Optional)
+
+### Rückgabewert
+
+- **Typ**: `boolean`
+- **Beschreibung**: `true`, wenn beide Eingaben auf denselben Locale-unabhängigen Pfad auflösen, ansonsten `false`.
+
+---
+
+## Anwendungsbeispiel
+
+### Grundlegende Nutzung
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { comparePaths } from "intlayer";
+
+comparePaths("/ru/path", "/path"); // true
+comparePaths("/ru/path/", "/path"); // true
+comparePaths("/ru/path", "/path/"); // true
+comparePaths("/ru/", "/"); // true
+comparePaths("/ru", "/"); // true
+comparePaths("ru/path", "/path"); // true
+comparePaths("", "/"); // true
+comparePaths("/ru", ""); // true
+comparePaths("/ru/path", "/other"); // false
+```
+
+### Absolute und relative URLs
+
+```typescript
+import { comparePaths } from "intlayer";
+
+comparePaths("https://example.com/ru/path", "/path"); // true
+```
+
+### Hervorheben des aktiven Navigationslinks
+
+```tsx
+import { comparePaths } from "intlayer";
+import { useLocation } from "react-router";
+
+const NavLink = ({ href, children }) => {
+  const { pathname } = useLocation();
+  const isActive = comparePaths(pathname, href);
+
+  return (
+    <a href={href} aria-current={isActive ? "page" : undefined}>
+      {children}
+    </a>
+  );
+};
+```
+
+---
+
+## normalizePath
+
+`normalizePath` gibt den kanonischen, Locale-unabhängigen Pfad zurück, der von `comparePaths` verwendet wird. Es entfernt das Locale-Segment, das Protokoll/den Host, den Query-String und den Hash, stellt einen einzelnen führenden Schrägstrich sicher, entfernt jegliche abschließenden Schrägstriche (außer für das Stammverzeichnis) und greift für leere Werte auf `/` zurück.
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { normalizePath } from "intlayer";
+
+normalizePath("/ru/path"); // "/path"
+normalizePath("/ru/path/"); // "/path"
+normalizePath("ru/path"); // "/path"
+normalizePath("/ru/"); // "/"
+normalizePath("/ru"); // "/"
+normalizePath(""); // "/"
+normalizePath("https://example.com/ru/path"); // "/path"
+```
+
+---
+
+## Verwandte Funktionen
+
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPathWithoutLocale.md): Entfernt das Locale-Segment aus einer URL oder einem Pfad.
+- [`getPrefix`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPrefix.md): Ermittelt das URL-Präfix für ein bestimmtes Locale.
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getLocalizedUrl.md): Generiert eine lokalisierte URL für ein bestimmtes Locale.
+
+---
+
+## TypeScript
+
+```typescript
+function normalizePath(inputUrl: string, locales?: Locales[]): string;
+
+function comparePaths(
+  pathname: string,
+  href: string,
+  locales?: Locales[]
+): boolean;
+```

package/docs/de/packages/intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - intlayer
   - exports
 history:
+  - version: 9.0.0
+    date: 2026-06-23
+    changes: "comparePaths-Dienstprogramm hinzugefügt"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Einheitliche Dokumentation für alle Exporte"
@@ -119,6 +122,8 @@ import "intlayer";
 | `getMultilingualUrls`  | `Function` | Erzeugt URLs für alle unterstützten Locales.                 | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getMultilingualUrls.md)   |
 | `getPathWithoutLocale` | `Function` | Entfernt das Locale-Präfix aus einem Pfad.                   | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPathWithoutLocale.md) |
 | `getPrefix`            | `Function` | Ermittelt das Locale-Präfix aus einem Pfad.                  | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getPrefix.md)                       |
+| `comparePaths`         | `Function` | Vergleicht zwei Pfade unter Ignorierung des Locales.         | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/comparePaths.md)                 |
+| `normalizePath`        | `Function` | Normalisiert einen Pfad zu einem Locale-unabhängigen Pfad.   | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/comparePaths.md)                 |
 | `getHTMLTextDir`       | `Function` | Gibt die Schreibrichtung (LTR/RTL) zurück.                   | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getHTMLTextDir.md)             |
 | `validatePrefix`       | `Function` | Validiert ein Locale-Präfix.                                 | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/validatePrefix.md)             |
 

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

@@ -29,6 +29,38 @@ author: aymericzip
 
 ## Beschreibung
 
+Die `getLocalizedUrl`-Funktion generiert eine lokalisierte URL, indem sie die gegebene URL mit dem angegebenen Locale präfixiert. Sie verarbeitet sowohl absolute als auch relative URLs und stellt sicher, dass das richtige Locale-Präfix basierend auf der Konfiguration angewendet wird.
+
+**Wichtigste Funktionen:**
+
+- Nur 2 Parameter erforderlich: `url` und `currentLocale`
+- Optionales `options`-Objekt mit `locales`, `defaultLocale` und `mode`
+- Verwendet die Internationalisierungskonfiguration deines Projekts als Standard
+- Kann mit minimalen Parametern für einfache Fälle oder vollständig angepasst für komplexe Szenarien verwendet werden
+- Unterstützt mehrere Routing-Modi: `prefix-no-default`, `prefix-all`, `no-prefix` und `search-params`
+
+---
+
+## Funktionssignatur
+
+```typescript
+getLocalizedUrl(
+  url: string,                   // Erforderlich
+  currentLocale: Locales,        // Erforderlich
+  options?: {                    // Optional
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): string
+```
+
+---
+
+## Parameter
+
+## Beschreibung
+
 Die Funktion `getLocalizedUrl` erzeugt eine lokalisierte URL, indem sie die angegebene URL mit dem spezifizierten Locale voranstellt. Sie verarbeitet sowohl absolute als auch relative URLs und stellt sicher, dass das korrekte Locale-Präfix basierend auf der Konfiguration angewendet wird.
 
 ---
@@ -67,6 +99,25 @@ Die Funktion `getLocalizedUrl` erzeugt eine lokalisierte URL, indem sie die ange
 
 ## Beispielhafte Verwendung
 
+### Grundlegende Verwendung (Nur erforderliche Parameter)
+
+Wenn Sie Ihr Projekt mit Internationalisierungseinstellungen konfiguriert haben, können Sie die Funktion nur mit den erforderlichen Parametern verwenden:
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Verwendet die Konfiguration Ihres Projekts für locales, defaultLocale und mode
+getLocalizedUrl("/about", Locales.FRENCH);
+// Ausgabe: "/fr/about" (angenommen, Französisch wird unterstützt und mode ist 'prefix-no-default')
+
+getLocalizedUrl("/about", Locales.ENGLISH);
+// Ausgabe: "/about" oder "/en/about" (je nach Ihrer mode-Einstellung)
+```
+
+### Erweiterte Verwendung (Mit optionalen Parametern)
+
+Sie können die Standardkonfiguration überschreiben, indem Sie den optionalen Parameter `options` bereitstellen:
+
 ### Relative URLs
 
 ```typescript codeFormat={["typescript", "esm"]}
@@ -114,6 +165,30 @@ getLocalizedUrl(
 // Ausgabe: "/about" für das Standard-Locale (Englisch)
 ```
 
+### Partielle Konfigurationsüberschreibung
+
+Sie können auch nur einige der optionalen Parameter bereitstellen. Die Funktion verwendet Ihre Projektkonfiguration für alle Parameter, die Sie nicht angeben:
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Nur die Locales überschreiben, Projektkonfiguration für defaultLocale und mode verwenden
+getLocalizedUrl("/about", Locales.SPANISH, {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+});
+
+// Nur mode überschreiben, Projektkonfiguration für locales und defaultLocale verwenden
+getLocalizedUrl("/about", Locales.ENGLISH, {
+  mode: "prefix-all", // Präfix für alle Locales einschließlich Standard erzwingen
+});
+
+// Mehrere Optionen überschreiben
+getLocalizedUrl("/about", Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params", // Abfrageparameter verwenden: /about?locale=fr
+});
+```
+
 ### Absolute URLs
 
 ```typescript