@intlayer/docs 5.5.11 → 5.5.12

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

@@ -186,28 +186,6 @@ getLocalizedUrl(
 
 ## 在应用中的使用
 
-在多语言应用中，配置 `locales` 和 `defaultLocale` 的国际化设置对于确保显示正确的语言至关重要。以下是 `getLocalizedUrl` 如何在应用程序设置中使用的示例：
-
-```tsx codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-// 支持的语言和默认语言的配置
-export default {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-} satisfies IntlayerConfig;
-
-export default config;
-```
-
-````javascript codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
 在多语言应用程序中，使用 `locales` 和 `defaultLocale` 配置国际化设置对于确保显示正确的语言至关重要。以下是如何在应用程序设置中使用 `getLocalizedUrl` 的示例：
 
 ```tsx codeFormat="typescript"
@@ -222,7 +200,7 @@ export default {
 } satisfies IntlayerConfig;
 
 export default config;
-````
+```
 
 ```javascript codeFormat="esm"
 import { Locales } from "intlayer";

package/frequent_questions/ar/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: خطأ في البناء في CI/CD
+description: تعلّم كيفية إصلاح أخطاء البناء التي تحدث في بيئات CI/CD.
+keywords:
+  - بناء
+  - خطأ
+  - ci
+  - cd
+  - خط الأنابيب
+  - intlayer
+  - القواميس
+  - next.js
+  - ما قبل البناء
+  - الأتمتة
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# خطأ في البناء في CI/CD
+
+إذا حصلت على خطأ مثل هذا في Next.js:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+إليك بعض الحلول:
+
+## 1. القواميس المفقودة
+
+تأكد من أن القواميس تم بناؤها في مرحلة البناء.
+
+من الشائع أن يعمل البناء محليًا ولكن لا يعمل على CI/CD. السبب هو أنه محليًا، يكون مجلد `.intlayer` موجودًا، ولكن على CI/CD، لا يكون موجودًا لأنه مستبعد من البناء.
+
+يمكنك إصلاح ذلك عن طريق إضافة سكربت ما قبل البناء في ملف `package.json` الخاص بمشروعك.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // سيتم تشغيله قبل البناء
+    "build": "next build",
+  },
+}
+```
+
+> لاحظ أنه إذا كنت تستخدم دالة `withIntlayer`، أو الإضافة المكافئة للباندلر في إطار عملك، فسيتم تشغيل سكربت ما قبل البناء قبل البناء.
+
+## 2. المتغيرات البيئية المفقودة أثناء وقت البناء / التشغيل
+
+في الحاويات، أو المنصات التي تعتمد النشر التلقائي، يُنصح باستبعاد ملف `.env` من البناء.
+
+```text fileName=".gitignore or .dockerignore"
+# المتغيرات البيئية
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+إذا لم تكن المتغيرات البيئية متاحة أثناء وقت البناء، فسيتم إصدار خطأ.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+من المحتمل أن هذا لا يتعلق بـ Intlayer. لذا تحقق من المتغيرات البيئية الخاصة بك أثناء وقت البناء على منصة CI/CD الخاصة بك.

package/frequent_questions/de/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Build-Fehler in CI/CD
+description: Erfahren Sie, wie Sie Build-Fehler beheben, die in CI/CD-Umgebungen auftreten.
+keywords:
+  - build
+  - fehler
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - wörterbücher
+  - next.js
+  - vorbuild
+  - automatisierung
+slugs:
+  - doc
+  - faq
+  - build-fehler-ci-cd
+---
+
+# Fehler beim Build in CI/CD
+
+Wenn Sie einen Fehler wie diesen in Next.js erhalten:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Hier einige Lösungen:
+
+## 1. Fehlende Wörterbücher
+
+Stellen Sie sicher, dass die Wörterbücher während der Build-Phase erstellt werden.
+
+Es kommt häufig vor, dass der Build lokal funktioniert, aber nicht in CI/CD. Der Grund ist, dass lokal das Verzeichnis `.intlayer` vorhanden ist, in CI/CD jedoch nicht, da es vom Build ausgeschlossen ist.
+
+Sie können dies beheben, indem Sie ein Prebuild-Skript in der `package.json` Ihres Projekts hinzufügen.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // Wird vor dem Build ausgeführt
+    "build": "next build",
+  },
+}
+```
+
+> Beachten Sie, dass wenn Sie die Funktion `withIntlayer` oder das entsprechende Bundler-Plugin für Ihr Framework verwenden, das Prebuild-Skript vor dem Build ausgeführt wird.
+
+## 2. Fehlende Umgebungsvariablen zur Build- oder Laufzeit
+
+In einem Container oder einer automatisch bereitgestellten Plattform wird empfohlen, die `.env`-Datei vom Build auszuschließen.
+
+```text fileName=".gitignore oder .dockerignore"
+# Umgebungsvariablen
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+Wenn Ihre Umgebungsvariablen zur Build-Zeit nicht verfügbar sind, wird ein Fehler ausgelöst.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+Dies hängt wahrscheinlich nicht mit Intlayer zusammen. Überprüfen Sie daher Ihre Umgebungsvariablen zur Build-Zeit auf Ihrer CI/CD-Plattform.

package/frequent_questions/en/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Build Error in CI/CD
+description: Learn how to fix build errors that occur in CI/CD environments.
+keywords:
+  - build
+  - error
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - dictionaries
+  - next.js
+  - prebuild
+  - automation
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# Error on build on CI/CD
+
+If you get an error like this on Next.js:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Here some solutions:
+
+## 1. Missing dictionaries
+
+Ensure that the dictionaries are built at the stage of the build.
+
+It's frquent that the build works locally but not on CI/CD. The reason is that locally, the `.intlayer` directory is present, but on CI/CD, it's not as it's excluded from the build.
+
+You can fix it by adding a prebuild script in the `package.json` of your project.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // Will run before the build
+    "build": "next build",
+  },
+}
+```
+
+> Not that if you use the `withIntlayer` function, or the equivalent bundler plugin for your framework, the prebuild script will be run before the build.
+
+## 2. Missing environment variables at build / run time
+
+In a container, or auto-deployed platform, it's recommended to exclude the `.env` file from the build.
+
+```text fileName=".gitignore or .dockerignore"
+# Environment variables
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+If your environment variables are not available at build time, an error will be thrown.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+It's probably not related to Intlayer. So check your environment variables at build time on your CI/CD platform.

package/frequent_questions/en-GB/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Build Error in CI/CD
+description: Learn how to fix build errors that occur in CI/CD environments.
+keywords:
+  - build
+  - error
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - dictionaries
+  - next.js
+  - prebuild
+  - automation
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# Error on build on CI/CD
+
+If you get an error like this on Next.js:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Here are some solutions:
+
+## 1. Missing dictionaries
+
+Ensure that the dictionaries are built at the stage of the build.
+
+It's frequent that the build works locally but not on CI/CD. The reason is that locally, the `.intlayer` directory is present, but on CI/CD, it is not as it is excluded from the build.
+
+You can fix this by adding a prebuild script in the `package.json` of your project.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // Will run before the build
+    "build": "next build",
+  },
+}
+```
+
+> Note that if you use the `withIntlayer` function, or the equivalent bundler plugin for your framework, the prebuild script will be run before the build.
+
+## 2. Missing environment variables at build / run time
+
+In a container, or auto-deployed platform, it is recommended to exclude the `.env` file from the build.
+
+```text fileName=".gitignore or .dockerignore"
+# Environment variables
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+If your environment variables are not available at build time, an error will be thrown.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+It is probably not related to Intlayer. Therefore, check your environment variables at build time on your CI/CD platform.

package/frequent_questions/es/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Error de compilación en CI/CD
+description: Aprende cómo solucionar errores de compilación que ocurren en entornos CI/CD.
+keywords:
+  - compilación
+  - error
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - diccionarios
+  - next.js
+  - prebuild
+  - automatización
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# Error en la compilación en CI/CD
+
+Si obtienes un error como este en Next.js:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Aquí algunas soluciones:
+
+## 1. Diccionarios faltantes
+
+Asegúrate de que los diccionarios se construyan en la etapa de compilación.
+
+Es frecuente que la compilación funcione localmente pero no en CI/CD. La razón es que localmente, el directorio `.intlayer` está presente, pero en CI/CD no, ya que está excluido de la compilación.
+
+Puedes solucionarlo agregando un script de precompilación en el `package.json` de tu proyecto.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // Se ejecutará antes de la compilación
+    "build": "next build",
+  },
+}
+```
+
+> Ten en cuenta que si usas la función `withIntlayer`, o el plugin equivalente para el empaquetador de tu framework, el script de precompilación se ejecutará antes de la compilación.
+
+## 2. Variables de entorno faltantes en tiempo de compilación / ejecución
+
+En un contenedor, o plataforma de despliegue automático, se recomienda excluir el archivo `.env` de la compilación.
+
+```text fileName=".gitignore or .dockerignore"
+# Variables de entorno
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+Si tus variables de entorno no están disponibles en tiempo de compilación, se generará un error.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+Probablemente no esté relacionado con Intlayer. Así que verifica tus variables de entorno en tiempo de compilación en tu plataforma CI/CD.

package/frequent_questions/fr/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Erreur de build en CI/CD
+description: Apprenez comment corriger les erreurs de build qui surviennent dans les environnements CI/CD.
+keywords:
+  - build
+  - erreur
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - dictionnaires
+  - next.js
+  - prébuild
+  - automatisation
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# Erreur lors du build en CI/CD
+
+Si vous obtenez une erreur comme celle-ci sur Next.js :
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Voici quelques solutions :
+
+## 1. Dictionnaires manquants
+
+Assurez-vous que les dictionnaires sont construits lors de l'étape de build.
+
+Il est fréquent que le build fonctionne localement mais pas en CI/CD. La raison est qu'en local, le répertoire `.intlayer` est présent, mais en CI/CD, il ne l'est pas car il est exclu du build.
+
+Vous pouvez corriger cela en ajoutant un script de prébuild dans le `package.json` de votre projet.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // S'exécutera avant le build
+    "build": "next build",
+  },
+}
+```
+
+> Notez que si vous utilisez la fonction `withIntlayer`, ou le plugin bundler équivalent pour votre framework, le script de prébuild sera exécuté avant le build.
+
+## 2. Variables d'environnement manquantes au moment du build / de l'exécution
+
+Dans un conteneur, ou une plateforme à déploiement automatique, il est recommandé d'exclure le fichier `.env` du build.
+
+```text fileName=".gitignore or .dockerignore"
+# Variables d'environnement
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+Si vos variables d'environnement ne sont pas disponibles au moment du build, une erreur sera levée.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+Cela n'est probablement pas lié à Intlayer. Vérifiez donc vos variables d'environnement au moment du build sur votre plateforme CI/CD.

package/frequent_questions/hi/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: CI/CD में बिल्ड त्रुटि
+description: जानें कि CI/CD वातावरण में होने वाली बिल्ड त्रुटियों को कैसे ठीक करें।
+keywords:
+  - build
+  - error
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - dictionaries
+  - next.js
+  - prebuild
+  - automation
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# CI/CD में बिल्ड पर त्रुटि
+
+यदि आपको Next.js में इस प्रकार की त्रुटि मिलती है:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+यहाँ कुछ समाधान दिए गए हैं:
+
+## 1. डिक्शनरी गायब हैं
+
+सुनिश्चित करें कि डिक्शनरी बिल्ड के चरण में बनाई गई हैं।
+
+यह सामान्य है कि बिल्ड स्थानीय रूप से काम करता है लेकिन CI/CD पर नहीं। इसका कारण यह है कि स्थानीय रूप से, `.intlayer` निर्देशिका मौजूद होती है, लेकिन CI/CD पर यह बिल्ड से बाहर रखी जाती है।
+
+आप इसे अपने प्रोजेक्ट के `package.json` में एक प्रीबिल्ड स्क्रिप्ट जोड़कर ठीक कर सकते हैं।
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // बिल्ड से पहले चलेगा
+    "build": "next build",
+  },
+}
+```
+
+> ध्यान दें कि यदि आप `withIntlayer` फ़ंक्शन का उपयोग करते हैं, या अपने फ्रेमवर्क के लिए समकक्ष बंडलर प्लगइन, तो प्रीबिल्ड स्क्रिप्ट बिल्ड से पहले चलेगा।
+
+## 2. बिल्ड / रन टाइम पर पर्यावरण चर गायब हैं
+
+कंटेनर या ऑटो-डिप्लॉयड प्लेटफ़ॉर्म में, यह अनुशंसित है कि `.env` फ़ाइल को बिल्ड से बाहर रखा जाए।
+
+```text fileName=".gitignore or .dockerignore"
+# पर्यावरण चर
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+यदि आपके पर्यावरण चर बिल्ड समय पर उपलब्ध नहीं हैं, तो एक त्रुटि उत्पन्न होगी।
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+यह संभवतः Intlayer से संबंधित नहीं है। इसलिए अपने CI/CD प्लेटफ़ॉर्म पर बिल्ड समय पर अपने पर्यावरण चर की जांच करें।

package/frequent_questions/it/build_error_CI_CD.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Errore di build in CI/CD
+description: Scopri come risolvere gli errori di build che si verificano negli ambienti CI/CD.
+keywords:
+  - build
+  - errore
+  - ci
+  - cd
+  - pipeline
+  - intlayer
+  - dizionari
+  - next.js
+  - prebuild
+  - automazione
+slugs:
+  - doc
+  - faq
+  - build-error-ci-cd
+---
+
+# Errore di build in CI/CD
+
+Se ricevi un errore come questo su Next.js:
+
+```text
+Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error
+```
+
+Ecco alcune soluzioni:
+
+## 1. Dizionari mancanti
+
+Assicurati che i dizionari siano costruiti nella fase di build.
+
+È frequente che la build funzioni localmente ma non su CI/CD. Il motivo è che localmente la directory `.intlayer` è presente, mentre su CI/CD non lo è perché è esclusa dalla build.
+
+Puoi risolvere aggiungendo uno script di prebuild nel `package.json` del tuo progetto.
+
+```json5 fileName=package.json
+{
+  // ...
+  "scripts": {
+    "prebuild": "npx intlayer dictionaries build", // Verrà eseguito prima della build
+    "build": "next build",
+  },
+}
+```
+
+> Nota che se usi la funzione `withIntlayer`, o il plugin bundler equivalente per il tuo framework, lo script di prebuild verrà eseguito prima della build.
+
+## 2. Variabili d'ambiente mancanti al momento della build o dell'esecuzione
+
+In un container, o su una piattaforma con deploy automatico, è consigliato escludere il file `.env` dalla build.
+
+```text fileName=".gitignore or .dockerignore"
+# Variabili d'ambiente
+.env
+**/.env
+.env.*
+**/.env.*
+```
+
+Se le tue variabili d'ambiente non sono disponibili al momento della build, verrà generato un errore.
+
+```ts
+import { Metadata } from "next";
+
+export const generateMetadata = async ({ params }): Promise<Metadata> => ({
+  metadataBase: new URL(process.env.NEXT_PUBLIC_URL),
+});
+```
+
+Probabilmente non è correlato a Intlayer. Quindi verifica le tue variabili d'ambiente al momento della build sulla tua piattaforma CI/CD.