@intlayer/docs 5.8.1 → 6.0.0-canary.1

package/docs/ja/dictionary/get_started.md

@@ -1,576 +0,0 @@
----
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
-title: 辞書 | はじめに
-description: 多言語ウェブサイトで辞書を宣言し使用する方法を紹介します。このオンラインドキュメントの手順に従って、数分でプロジェクトを設定しましょう。
-keywords:
-  - はじめに
-  - 国際化
-  - ドキュメント
-  - Intlayer
-  - Next.js
-  - JavaScript
-  - React
-slugs:
-  - doc
-  - concept
-  - content
----
-
-# コンテンツの宣言を始める
-
-<iframe title="i18n、Markdown、JSON…すべてを管理するための一つのソリューション | 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"/>
-
-## ファイル拡張子
-
-デフォルトでは、Intlayerは以下の拡張子を持つすべてのファイルをコンテンツ宣言用に監視します：
-
-- `.content.json`
-- `.content.ts`
-- `.content.tsx`
-- `.content.js`
-- `.content.jsx`
-- `.content.mjs`
-- `.content.mjx`
-- `.content.cjs`
-- `.content.cjx`
-
-アプリケーションはデフォルトで、`./src/**/*.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}` のグロブパターンに一致するファイルを検索します。
-
-これらのデフォルト拡張子はほとんどのアプリケーションに適しています。ただし、特定の要件がある場合は、管理方法については[コンテンツ拡張子カスタマイズガイド](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/configuration.md#content-configuration)を参照してください。
-
-設定オプションの完全なリストについては、設定ドキュメントをご覧ください。
-
-## コンテンツの宣言
-
-辞書を作成および管理します：
-
-```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: "こんにちは世界",
-        numberContent: 123,
-        booleanContent: true,
-        javaScriptContent: `${process.env.NODE_ENV}`, // 環境変数NODE_ENVの値
-      },
-    },
-    multilingualContent: t({
-      en: "English content",
-      "en-GB": "English content (UK)",
-      fr: "French content",
-      es: "Spanish content",
-    }),
-    quantityContent: enu({
-      "<-1": "マイナス1台未満の車",
-      "-1": "マイナス1台の車",
-      "0": "車はありません",
-      "1": "1台の車",
-      ">5": "いくつかの車",
-      ">19": "多くの車",
-    }),
-    conditionalContent: cond({
-      true: "検証が有効です",
-      false: "検証が無効です",
-    }),
-    insertionContent: insert("こんにちは {{name}}!"),
-    nestedContent: nest(
-      "navbar", // ネストする辞書のキー
-      "login.button" // [オプション] ネストするコンテンツのパス
-    ),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json()),
-    markdownContent: md("# マークダウンの例"),
-
-    /*
-     * `react-intlayer` または `next-intlayer` を使用している場合のみ利用可能
-     */
-    jsxContent: <h1>私のタイトル</h1>,
-  },
-} satisfies Dictionary<Content>; // [optional] Dictionaryはジェネリックであり、辞書のフォーマットを強化することができます
-```
-
-```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: "Hello World",
-        numberContent: 123,
-        booleanContent: true,
-        javaScriptContent: `${process.env.NODE_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": "マイナス1台未満の車",
-      "-1": "マイナス1台の車",
-      "0": "車はありません",
-      "1": "1台の車",
-      ">5": "いくつかの車",
-      ">19": "多くの車",
-    }),
-    conditionalContent: cond({
-      true: "検証が有効です",
-      false: "検証が無効です",
-    }),
-    insertionContent: insert("こんにちは {{name}}!"),
-    nestedContent: nest(
-      "navbar", // ネストする辞書のキー
-      "login.button" // [オプション] ネストするコンテンツのパス
-    ),
-    markdownContent: md("# マークダウンの例"),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json())
-
-    // `react-intlayer` または `next-intlayer` を使用している場合のみ利用可能
-    jsxContent: <h1>私のタイトル</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: "こんにちは世界",
-        numberContent: 123,
-        booleanContent: true,
-        javaScriptContent: `${process.env.NODE_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": "マイナス1台未満の車",
-      "-1": "マイナス1台の車",
-      "0": "車はありません",
-      "1": "1台の車",
-      ">5": "いくつかの車",
-      ">19": "多くの車",
-    }),
-    conditionalContent: cond({
-      true: "検証が有効です",
-      false: "検証が無効です",
-    }),
-    insertionContent: insert("こんにちは {{name}}!"),
-    nestedContent: nest(
-      "navbar", // ネストする辞書のキー
-      "login.button" // [オプション] ネストするコンテンツのパス
-    ),
-    markdownContent: md("# マークダウンの例"),
-    fileContent: file("./path/to/file.txt"),
-    externalContent: fetch("https://example.com").then((res) => res.json())
-
-    // `react-intlayer` または `next-intlayer` を使用している場合のみ利用可能
-    jsxContent: <h1>私のタイトル</h1>,
-  },
-};
-```
-
-```json5 fileName="src/example.content.json"  contentDeclarationFormat="json"
-{
-  "$schema": "https://intlayer.org/schema.json",
-  "key": "page",
-  "content": {
-    "imbricatedContent": {
-      "imbricatedContent2": {
-        "stringContent": "こんにちは世界",
-        "numberContent": 123,
-        "booleanContent": true,
-      },
-      "imbricatedArray": [1, 2, 3],
-    },
-    "multilingualContent": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "English content",
-        "en-GB": "English content (UK)",
-        "fr": "French content",
-        "es": "Spanish content",
-      },
-    },
-    "quantityContent": {
-      "nodeType": "enumeration",
-      "enumeration": {
-        "0": "車はありません",
-        "1": "車が一台",
-        "<-1": "マイナス1台未満の車",
-        "-1": "マイナス1台の車",
-        ">5": "いくつかの車",
-        ">19": "多くの車",
-      },
-    },
-    "conditionalContent": {
-      "nodeType": "condition",
-      "condition": {
-        "true": "検証が有効です",
-        "false": "検証が無効です",
-      },
-    },
-    "insertionContent": {
-      "nodeType": "insertion",
-      "insertion": "こんにちは {{name}}！",
-    },
-    "nestedContent": {
-      "nodeType": "nested",
-      "nested": { "dictionaryKey": "app" },
-    },
-    "markdownContent": {
-      "nodeType": "markdown",
-      "markdown": "# マークダウンの例",
-    },
-    "fileContent": {
-      "nodeType": "file",
-      "file": "./path/to/file.txt",
-    },
-    "jsxContent": {
-      "type": "h1",
-      "key": null,
-      "ref": null,
-      "props": {
-        "children": ["私のタイトル"],
-      },
-    },
-  },
-}
-```
-
-## 関数の入れ子構造
-
-問題なく関数を他の関数に入れ子にすることができます。
-
-例：
-
-```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` は `['Hi', ' ', 'John Doe']` を返します
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // 条件、列挙、多言語コンテンツを入れ子にした複合コンテンツ
-    // `getIntlayer('page','en').advancedContent(true)(10)` は '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` は `['Hi', ' ', 'John Doe']` を返します
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // 条件、列挙、多言語コンテンツを組み合わせた複合コンテンツ
-    // `getIntlayer('page','en').advancedContent(true)(10)` は '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",
-      }),
-    }),
-  },
-};
-
-/** @type {import('intlayer').Dictionary} */
-export default {
-  key: "page",
-  content: {
-    // `getIntlayer('page','en').hiMessage` は `['Hi', ' ', 'John Doe']` を返します
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // 条件、列挙、多言語コンテンツを組み合わせた複合コンテンツ
-    // `getIntlayer('page','en').advancedContent(true)(10)` は '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",
-          ja: "複数のアイテムが見つかりました",
-        }),
-      }),
-      false: t({
-        en: "No valid data available",
-        fr: "Aucune donnée valide disponible",
-        es: "No hay datos válidos disponibles",
-        ja: "有効なデータがありません",
-      }),
-    }),
-  },
-};
-```
-
-```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` は `['Hi', ' ', 'John Doe']` を返します
-    hiMessage: [
-      t({
-        en: "Hi",
-        fr: "Salut",
-        ja: "こんにちは",
-        es: "Hola",
-      }),
-      " ",
-      getName(),
-    ],
-    // 条件、列挙、多言語コンテンツを組み合わせた複合コンテンツ
-    // `getIntlayer('page','en').advancedContent(true)(10)` は '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",
-      }),
-    }),
-  },
-};
-```
-
-```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",
-                "ja": "アイテムが見つかりませんでした",
-              },
-            },
-            "1": {
-              "nodeType": "translation",
-              "translation": {
-                "en": "One item found",
-                "fr": "Un article trouvé",
-                "es": "Se encontró un artículo",
-                "ja": "1つのアイテムが見つかりました",
-              },
-            },
-            ">1": {
-              "nodeType": "translation",
-              "translation": {
-                "en": "Multiple items found",
-                "fr": "Plusieurs articles trouvés",
-                "es": "Se encontraron múltiples artículos",
-                "ja": "複数のアイテムが見つかりました",
-              },
-            },
-          },
-        },
-        "false": {
-          "nodeType": "translation",
-          "translation": {
-            "en": "No valid data available",
-            "fr": "Aucune donnée valide disponible",
-            "es": "No hay datos válidos disponibles",
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-## 追加リソース
-
-Intlayerの詳細については、以下のリソースを参照してください：
-
-- [ロケール別コンテンツ宣言ドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/per_locale_file.md)
-- [翻訳コンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/translation.md)
-- [列挙コンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/enumeration.md)
-- [条件コンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/condition.md)
-- [挿入コンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/insertion.md)
-- [ファイルコンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/file.md)
-- [ネスティングコンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/nesting.md)
-- [マークダウンコンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/markdown.md)
-- [関数フェッチコンテンツドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/function_fetching.md)
-
-## ドキュメント履歴
-
-- 5.5.10 - 2025-06-29: 履歴初期化

package/docs/ko/dictionary/content_extention_customization.md

@@ -1,100 +0,0 @@
----
-createdAt: 2025-02-07
-updatedAt: 2025-06-29
-title: 콘텐츠 확장자 사용자 정의
-description: 콘텐츠 선언 파일의 확장자를 사용자 정의하는 방법을 알아보세요. 이 문서를 따라 프로젝트에서 조건을 효율적으로 구현할 수 있습니다.
-keywords:
-  - 콘텐츠 확장자 사용자 정의
-  - 문서
-  - Intlayer
-slugs:
-  - doc
-  - concept
-  - content
----
-
-# 콘텐츠 확장자 사용자 정의
-
-## 콘텐츠 파일 확장자
-
-Intlayer는 콘텐츠 선언 파일의 확장자를 사용자 정의할 수 있도록 합니다. 이러한 사용자 정의는 대규모 프로젝트 관리에 유연성을 제공하며, 다른 모듈과의 충돌을 방지하는 데 도움이 됩니다.
-
-### 기본 확장자
-
-기본적으로 Intlayer는 다음 확장자를 가진 모든 파일을 콘텐츠 선언용으로 감시합니다:
-
-- `.content.json`
-- `.content.ts`
-- `.content.tsx`
-- `.content.js`
-- `.content.jsx`
-- `.content.mjs`
-- `.content.mjx`
-- `.content.cjs`
-- `.content.cjx`
-
-이 기본 확장자는 대부분의 애플리케이션에 적합합니다. 그러나 특정 요구 사항이 있는 경우, 빌드 프로세스를 간소화하고 다른 구성 요소와의 충돌 위험을 줄이기 위해 사용자 정의 확장자를 정의할 수 있습니다.
-
-### 콘텐츠 확장자 사용자 정의
-
-Intlayer가 콘텐츠 선언 파일을 식별하는 데 사용하는 파일 확장자를 사용자 정의하려면 Intlayer 구성 파일에서 이를 지정할 수 있습니다. 이 방법은 감시 범위를 제한하여 빌드 성능을 향상시키는 대규모 프로젝트에 유용합니다.
-
-다음은 구성에서 사용자 정의 콘텐츠 확장자를 정의하는 예입니다:
-
-```typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import type { IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  content: {
-    fileExtensions: [".my_content.ts", ".my_content.tsx"], // 사용자 정의 확장자
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.mjs" codeFormat="esm"
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  content: {
-    fileExtensions: [".my_content.cjs", ".my_content.cjx"], // 사용자 정의 확장자
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  content: {
-    fileExtensions: [".my_content.mjs", ".my_content.mjx"], // 사용자 정의 확장자
-  },
-};
-
-module.exports = config;
-```
-
-이 예제에서는 `.my_content.ts`와 `.my_content.tsx` 두 가지 사용자 정의 확장자를 지정했습니다. Intlayer는 이 확장자를 가진 파일만 감시하여 사전을 빌드합니다.
-
-### 사용자 정의 확장자의 이점
-
-- **빌드 성능**: 감시하는 파일 범위를 줄이면 대규모 프로젝트에서 빌드 성능이 크게 향상될 수 있습니다.
-- **충돌 방지**: 커스텀 확장자는 프로젝트 내 다른 JavaScript 또는 TypeScript 파일과의 충돌을 방지하는 데 도움이 됩니다.
-- **조직화**: 커스텀 확장자를 사용하면 프로젝트 요구에 맞게 콘텐츠 선언 파일을 체계적으로 관리할 수 있습니다.
-
-### 커스텀 확장자 가이드라인
-
-콘텐츠 파일 확장자를 커스터마이징할 때는 다음 가이드라인을 참고하세요:
-
-- **고유성**: 프로젝트 내에서 충돌을 피하기 위해 고유한 확장자를 선택하세요.
-- **일관된 명명법**: 코드 가독성과 유지보수를 위해 일관된 명명 규칙을 사용하세요.
-- **일반 확장자 회피**: 다른 모듈이나 라이브러리와의 충돌을 방지하기 위해 `.ts`나 `.js` 같은 일반적인 확장자 사용을 피하세요.
-
-## 결론
-
-Intlayer에서 콘텐츠 파일 확장자를 사용자 정의하는 것은 대규모 애플리케이션에서 성능을 최적화하고 충돌을 방지하는 데 유용한 기능입니다. 이 문서에 설명된 지침을 따르면 콘텐츠 선언을 효과적으로 관리하고 프로젝트의 다른 부분과 원활하게 통합할 수 있습니다.
-
-## 문서 이력
-
-- 5.5.10 - 2025-06-29: 초기 이력