@intlayer/docs 5.8.1 → 6.0.0-canary.1

package/docs/es/dictionary/get_started.md

@@ -1,527 +0,0 @@
----
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
-title: Diccionario | Primeros pasos
-description: Descubre cómo declarar y usar diccionarios en tu sitio web multilingüe. Sigue los pasos en esta documentación en línea para configurar tu proyecto en pocos minutos.
-keywords:
-  - Primeros pasos
-  - Internacionalización
-  - Documentación
-  - Intlayer
-  - Next.js
-  - JavaScript
-  - React
-slugs:
-  - doc
-  - concept
-  - content
----
-
-# Primeros pasos en la declaración de tu contenido
-
-<iframe title="i18n, Markdown, JSON… una única solución para gestionarlo todo | Intlayer" class="m-auto aspect-[16/9] w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/1VHgSY_j9_I?autoplay=0&amp;origin=http://intlayer.org&amp;controls=0&amp;rel=1"/>
-
-## Extensiones de archivos
-
-Por defecto, Intlayer vigila todos los archivos con las siguientes extensiones para declaraciones de contenido:
-
-- `.content.json`
-- `.content.ts`
-- `.content.tsx`
-- `.content.js`
-- `.content.jsx`
-- `.content.mjs`
-- `.content.mjx`
-- `.content.cjs`
-- `.content.cjx`
-
-La aplicación buscará archivos que coincidan con el patrón glob `./src/**/*.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}` por defecto.
-
-Estas extensiones predeterminadas son adecuadas para la mayoría de las aplicaciones. Sin embargo, si tienes requisitos específicos, consulta la [guía de personalización de extensiones de contenido](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#content-configuration) para obtener instrucciones sobre cómo gestionarlas.
-
-Para una lista completa de opciones de configuración, visita la documentación de configuración.
-
-## Declara Tu Contenido
-
-Crea y gestiona tus diccionarios:
-
-```tsx fileName="src/example.content.tsx" contentDeclarationFormat="typescript"
-import { type ReactNode } from "react";
-import {
-  t,
-  enu,
-  cond,
-  nest,
-  md,
-  insert,
-  file,
-  type Dictionary,
-} from "intlayer";
-
-interface Content {
-  imbricatedContent: {
-    imbricatedContent2: {
-      stringContent: string;
-      numberContent: number;
-      booleanContent: boolean;
-      javaScriptContent: string;
-    };
-  };
-  multilingualContent: string;
-  quantityContent: string;
-  conditionalContent: string;
-  markdownContent: never;
-  externalContent: string;
-  insertionContent: string;
-  nestedContent: string;
-  fileContent: string;
-  jsxContent: ReactNode;
-}
-
-export default {
-  key: "page",
-  content: {
-    imbricatedContent: {
-      imbricatedContent2: {
-        stringContent: "Hola Mundo", // Contenido de cadena
-        numberContent: 123, // Contenido numérico
-        booleanContent: true, // Contenido booleano
-        javaScriptContent: `${process.env.NODE_ENV}`, // Contenido JavaScript
-      },
-    },
-    multilingualContent: t({
-      en: "English content",
-      "en-GB": "English content (UK)",
-      fr: "French content",
-      es: "Contenido en español",
-    }),
-    quantityContent: enu({
-      "<-1": "Menos de menos un coche",
-      "-1": "Menos un coche",
-      "0": "Ningún coche",
-      "1": "Un coche",
-      ">5": "Algunos coches",
-      ">19": "Muchos coches",
-    }),
-    conditionalContent: cond({
-      true: "La validación está habilitada",
-      false: "La validación está deshabilitada",
-    }),
-    insertionContent: insert("¡Hola {{name}}!"),
-    nestedContent: nest(
-      "navbar", // La clave del diccionario para anidar
-      "login.button" // [Opcional] La ruta al contenido para anidar
-    ),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json()),
-    markdownContent: md("# Ejemplo de Markdown"),
-
-    /*
-     * Solo disponible usando `react-intlayer` o `next-intlayer`
-     */
-    jsxContent: <h1>Mi título</h1>,
-  },
-} satisfies Dictionary<Content>; // [opcional] Dictionary es genérico y te permite reforzar el formato de tu diccionario
-```
-
-```javascript fileName="src/example.content.mjx" contentDeclarationFormat="esm"
-import { t, enu, cond, nest, md, insert, file } from "intlayer";
-
-/** @type {import('intlayer').Dictionary} */
-export default {
-  key: "page",
-  content: {
-    imbricatedContent: {
-      imbricatedContent2: {
-        stringContent: "Hola Mundo",
-        numberContent: 123,
-        booleanContent: true,
-        javaScriptContent: `${process.env.NODE_ENV}`,
-      },
-      imbricatedArray: [1, 2, 3],
-    },
-    multilingualContent: t({
-      en: "English content",
-      "en-GB": "English content (UK)",
-      fr: "French content",
-      es: "Spanish content",
-    }),
-    quantityContent: enu({
-      "<-1": "Menos de menos un coche",
-      "-1": "Menos un coche",
-      "0": "Ningún coche",
-      "1": "Un coche",
-      ">5": "Algunos coches",
-      ">19": "Muchos coches",
-    }),
-    conditionalContent: cond({
-      true: "La validación está habilitada",
-      false: "La validación está deshabilitada",
-    }),
-    insertionContent: insert("¡Hola {{name}}!"),
-    nestedContent: nest(
-      "navbar", // La clave del diccionario para anidar
-      "login.button" // [Opcional] La ruta al contenido para anidar
-    ),
-    markdownContent: md("# Ejemplo de Markdown"),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json())
-
-    // Solo disponible usando `react-intlayer` o `next-intlayer`
-    jsxContent: <h1>Mi título</h1>,
-  },
-};
-```
-
-```javascript fileName="src/example.content.cjx" contentDeclarationFormat="commonjs"
-const { t, enu, cond, nest, md, insert, file } = require("intlayer");
-
-/** @type {import('intlayer').Dictionary} */
-module.exports = {
-  key: "page",
-  content: {
-    imbricatedContent: {
-      imbricatedContent2: {
-        stringContent: "Hola Mundo",
-        numberContent: 123,
-        booleanContent: true,
-        javaScriptContent: `${process.env.NODE_ENV}`, // Contenido de JavaScript
-      },
-      imbricatedArray: [1, 2, 3], // Array imbricado
-    },
-    multilingualContent: t({
-      en: "Contenido en inglés",
-      "en-GB": "Contenido en inglés (Reino Unido)",
-      fr: "Contenido en francés",
-      es: "Contenido en español",
-    }),
-    quantityContent: enu({
-      "<-1": "Menos de menos un coche",
-      "-1": "Menos un coche",
-      "0": "Ningún coche",
-      "1": "Un coche",
-      ">5": "Algunos coches",
-      ">19": "Muchos coches",
-    }),
-    conditionalContent: cond({
-      true: "La validación está habilitada",
-      false: "La validación está deshabilitada",
-    }),
-    insertionContent: insert("¡Hola {{name}}!"),
-    nestedContent: nest(
-      "navbar", // La clave del diccionario para anidar
-      "login.button" // [Opcional] La ruta al contenido para anidar
-    ),
-    markdownContent: md("# Ejemplo de Markdown"),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json())
-
-    // Solo disponible usando `react-intlayer` o `next-intlayer`
-    jsxContent: <h1>Mi título</h1>,
-  },
-};
-```
-
-```json5 fileName="src/example.content.json"  contentDeclarationFormat="json"
-{
-  "$schema": "https://intlayer.org/schema.json",
-  "key": "page",
-  "content": {
-    "imbricatedContent": {
-      "imbricatedContent2": {
-        "stringContent": "Hola Mundo",
-        "numberContent": 123,
-        "booleanContent": true,
-      },
-      "imbricatedArray": [1, 2, 3],
-    },
-    "multilingualContent": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "Contenido en inglés",
-        "en-GB": "Contenido en inglés (Reino Unido)",
-        "fr": "Contenido en francés",
-        "es": "Contenido en español",
-      },
-    },
-    "quantityContent": {
-      "nodeType": "enumeration",
-      "enumeration": {
-        "0": "Sin coches",
-        "1": "Un coche",
-        "<-1": "Menos de menos un coche",
-        "-1": "Menos un coche",
-        ">5": "Algunos coches",
-        ">19": "Muchos coches",
-      },
-    },
-    "conditionalContent": {
-      "nodeType": "condition",
-      "condition": {
-        "true": "La validación está habilitada",
-        "false": "La validación está deshabilitada",
-      },
-    },
-    "insertionContent": {
-      "nodeType": "insertion",
-      "insertion": "¡Hola {{name}}!",
-    },
-    "nestedContent": {
-      "nodeType": "nested",
-      "nested": { "dictionaryKey": "app" },
-    },
-    "markdownContent": {
-      "nodeType": "markdown",
-      "markdown": "# Ejemplo de Markdown",
-    },
-    "fileContent": {
-      "nodeType": "file",
-      "file": "./path/to/file.txt",
-    },
-    "jsxContent": {
-      "type": "h1",
-      "key": null,
-      "ref": null,
-      "props": {
-        "children": ["Mi título"],
-      },
-    },
-  },
-}
-```
-
-## Imbricación de funciones
-
-Puedes sin problema imbricar funciones dentro de otras.
-
-Ejemplo:
-
-```javascript fileName="src/example.content.tsx" contentDeclarationFormat="typescript"
-import { t, enu, cond, nest, md, type Dictionary } from "intlayer";
-
-const getName = async () => "John Doe";
-
-export default {
-  key: "page",
-  content: {
-    // `getIntlayer('page','en').hiMessage` devuelve `['Hi', ' ', 'John Doe']`
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // Contenido compuesto imbricando condición, enumeración y contenido multilingüe
-    // `getIntlayer('page','en').advancedContent(true)(10)` devuelve 'Multiple items found'
-    advancedContent: cond({
-      true: enu({
-        "0": t({
-          en: "No items found",
-          fr: "Aucun article trouvé",
-          es: "No se encontraron artículos",
-        }),
-        "1": t({
-          en: "One item found",
-          fr: "Un article trouvé",
-          es: "Se encontró un artículo",
-        }),
-        ">1": t({
-          en: "Multiple items found",
-          fr: "Plusieurs articles trouvés",
-          es: "Se encontraron múltiples artículos",
-        }),
-      }),
-      false: t({
-        en: "No valid data available",
-        fr: "Aucune donnée valide disponible",
-        es: "No hay datos válidos disponibles",
-      }),
-    }),
-  },
-} satisfies Dictionary;
-```
-
-```javascript fileName="src/example.content.mjx" contentDeclarationFormat="esm"
-import { t, enu, cond, nest, md } from "intlayer";
-
-const getName = async () => "John Doe";
-
-/** @type {import('intlayer').Dictionary} */
-export default {
-  key: "page",
-  content: {
-    // `getIntlayer('page','en').hiMessage` devuelve `['Hola', ' ', 'John Doe']`
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // Contenido compuesto que imbrica condición, enumeración y contenido multilingüe
-    // `getIntlayer('page','en').advancedContent(true)(10)` devuelve 'Se encontraron múltiples artículos'
-    advancedContent: cond({
-      true: enu({
-        "0": t({
-          en: "No items found",
-          fr: "Aucun article trouvé",
-          es: "No se encontraron artículos",
-        }),
-        "1": t({
-          en: "One item found",
-          fr: "Un article trouvé",
-          es: "Se encontró un artículo",
-/        }),
-        ">1": t({
-          en: "Multiple items found",
-          fr: "Plusieurs articles trouvés",
-          es: "Se encontraron múltiples artículos",
-        }),
-      }),
-      false: t({
-        en: "No valid data available",
-        fr: "Aucune donnée valide disponible",
-        es: "No hay datos válidos disponibles",
-      }),
-    }),
-  },
-};
-```
-
-```javascript fileName="src/example.content.cjx" contentDeclarationFormat="commonjs"
-const { t, enu, cond, nest, md } = require("intlayer");
-
-const getName = async () => "John Doe";
-
-/** @type {import('intlayer').Dictionary} */
-module.exports = {
-  key: "page",
-  content: {
-    // `getIntlayer('page','en').hiMessage` devuelve `['Hola', ' ', 'John Doe']`
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // Contenido compuesto que imbrica condición, enumeración y contenido multilingüe
-    // `getIntlayer('page','en').advancedContent(true)(10) devuelve 'Se encontraron múltiples artículos'`
-    advancedContent: cond({
-      true: enu({
-        "0": t({
-          en: "No items found",
-          fr: "Aucun article trouvé",
-          es: "No se encontraron artículos",
-        }),
-        "1": t({
-          en: "One item found",
-          fr: "Un article trouvé",
-          es: "Se encontró un artículo",
-        }),
-        ">1": t({
-          en: "Multiple items found",
-          fr: "Plusieurs articles trouvés",
-          es: "Se encontraron múltiples artículos",
-        }),
-      }),
-      false: t({
-        en: "No valid data available",
-        fr: "Aucune donnée valide disponible",
-        es: "No hay datos válidos disponibles",
-      }),
-    }),
-  },
-};
-```
-
-```json5 fileName="src/example.content.json"  contentDeclarationFormat="json"
-{
-  "$schema": "https://intlayer.org/schema.json",
-  "key": "page",
-  "content": {
-    "hiMessage": {
-      "nodeType": "composite",
-      "composite": [
-        {
-          "nodeType": "translation",
-          "translation": {
-            "en": "Hi",
-            "fr": "Salut",
-            "es": "Hola",
-          },
-        },
-        " ",
-        "John Doe",
-      ],
-    },
-    "advancedContent": {
-      "nodeType": "condition",
-      "condition": {
-        "true": {
-          "nodeType": "enumeration",
-          "enumeration": {
-            "0": {
-              "nodeType": "translation",
-              "translation": {
-                "en": "No items found",
-                "fr": "Aucun article trouvé",
-                "es": "No se encontraron artículos",
-              },
-            },
-            "1": {
-              "nodeType": "translation",
-              "translation": {
-                "en": "One item found",
-                "fr": "Un article trouvé",
-                "es": "Se encontró un artículo",
-              },
-            },
-            ">1": {
-              "nodeType": "translation",
-              "translation": {
-                "en": "Multiple items found",
-                "fr": "Plusieurs articles trouvés",
-                "es": "Se encontraron múltiples artículos",
-              },
-            },
-          },
-        },
-        "false": {
-          "nodeType": "translation",
-          "translation": {
-            "en": "No valid data available",
-            "fr": "Aucune donnée valide disponible",
-            "es": "No hay datos válidos disponibles",
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-## Recursos Adicionales
-
-Para más detalles en Intlayer, consulte los siguientes recursos:
-
-- [Documentación de Declaración de Contenido por Localización](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/per_locale_file.md)
-- [Documentación de Contenido de Traducción](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/translation.md)
-- [Documentación de Contenido de Enumeración](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/enumeration.md)
-- [Documentación de Contenido de Condición](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/condition.md)
-- [Documentación de Contenido de Inserción](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/insertion.md)
-- [Documentación de Contenido de Archivo](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/file.md)
-- [Documentación de Contenido Anidado](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/nesting.md)
-- [Documentación de Contenido Markdown](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/markdown.md)
-- [Documentación de Contenido de Obtención de Funciones](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/dictionary/function_fetching.md)
-
-## Historial del Documento
-
-- 5.5.10 - 2025-06-29: Historial inicial

package/docs/fr/dictionary/content_extention_customization.md

@@ -1,100 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: Personnalisation des extensions de contenu
-description: Apprenez à personnaliser les extensions de vos fichiers de déclaration de contenu. Suivez cette documentation pour implémenter efficacement des conditions dans votre projet.
-keywords:
-  - Personnalisation des extensions de contenu
-  - Documentation
-  - Intlayer
-slugs:
-  - doc
-  - concept
-  - content
----
-
-# Personnalisation des extensions de contenu
-
-## Extensions des fichiers de contenu
-
-Intlayer vous permet de personnaliser les extensions de vos fichiers de déclaration de contenu. Cette personnalisation offre une flexibilité dans la gestion de projets à grande échelle et aide à éviter les conflits avec d'autres modules.
-
-### Extensions par défaut
-
-Par défaut, Intlayer surveille tous les fichiers avec les extensions suivantes pour les déclarations de contenu :
-
-- `.content.json`
-- `.content.ts`
-- `.content.tsx`
-- `.content.js`
-- `.content.jsx`
-- `.content.mjs`
-- `.content.mjx`
-- `.content.cjs`
-- `.content.cjx`
-
-Ces extensions par défaut conviennent à la plupart des applications. Cependant, lorsque vous avez des besoins spécifiques, vous pouvez définir des extensions personnalisées pour rationaliser le processus de build et réduire le risque de conflits avec d'autres composants.
-
-### Personnalisation des extensions de contenu
-
-Pour personnaliser les extensions de fichiers qu'Intlayer utilise pour identifier les fichiers de déclaration de contenu, vous pouvez les spécifier dans le fichier de configuration d'Intlayer. Cette approche est bénéfique pour les projets à grande échelle où limiter la portée du processus de surveillance améliore les performances de construction.
-
-Voici un exemple de définition d'extensions de contenu personnalisées dans votre configuration :
-
-```typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import type { IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  content: {
-    fileExtensions: [".my_content.ts", ".my_content.tsx"], // Vos extensions personnalisées
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.mjs" codeFormat="esm"
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  content: {
-    fileExtensions: [".my_content.cjs", ".my_content.cjx"], // Vos extensions personnalisées
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  content: {
-    fileExtensions: [".my_content.mjs", ".my_content.mjx"], // Vos extensions personnalisées
-  },
-};
-
-module.exports = config;
-```
-
-Dans cet exemple, la configuration spécifie deux extensions personnalisées : `.my_content.ts` et `.my_content.tsx`. Intlayer ne surveillera que les fichiers avec ces extensions pour construire les dictionnaires.
-
-### Avantages des extensions personnalisées
-
-- **Performance de construction** : Réduire la portée des fichiers surveillés peut améliorer significativement les performances de construction dans les grands projets.
-- **Évitement des conflits** : Les extensions personnalisées aident à prévenir les conflits avec d'autres fichiers JavaScript ou TypeScript dans votre projet.
-- **Organisation** : Les extensions personnalisées vous permettent d'organiser vos fichiers de déclaration de contenu selon les besoins de votre projet.
-
-### Directives pour les extensions personnalisées
-
-Lors de la personnalisation des extensions de fichiers de contenu, gardez à l'esprit les directives suivantes :
-
-- **Unicité** : Choisissez des extensions uniques dans votre projet pour éviter les conflits.
-- **Nommage cohérent** : Utilisez des conventions de nommage cohérentes pour une meilleure lisibilité et maintenance du code.
-- **Éviter les extensions courantes** : Évitez d'utiliser des extensions courantes comme `.ts` ou `.js` pour prévenir les conflits avec d'autres modules ou bibliothèques.
-
-## Conclusion
-
-La personnalisation des extensions de fichiers de contenu dans Intlayer est une fonctionnalité précieuse pour optimiser les performances et éviter les conflits dans les applications à grande échelle. En suivant les directives décrites dans cette documentation, vous pouvez gérer efficacement vos déclarations de contenu et assurer une intégration fluide avec les autres parties de votre projet.
-
-## Historique de la documentation
-
-- 5.5.10 - 2025-06-29 : Historique initial