フレームワーク統合
人気のフレームワークで champollion をセットアップするための手順です。
- Hugo
- Next.js (next-intl)
- React (react-i18next)
Hugo (TOML / YAML / Markdown)
プロジェクト構成
Hugo は文字列の翻訳に i18n/ を、ページコンテンツに content/ を使用します:
my-hugo-site/
├── i18n/
│ ├── en.toml ← source of truth
│ ├── fr.toml
│ └── ja.toml
├── content/
│ ├── posts/
│ │ ├── hello.md ← source (English)
│ │ ├── hello.fr.md
│ │ └── hello.ja.md
│ └── about.md
└── .env.local
セットアップ
npm install --save-dev champollion
{
"version": 3,
"inputLocale": "en",
"localesDir": "./i18n",
"contentDir": "./content",
"format": "auto",
"languages": ["fr", "de", "ja", "es", "ko", "zh"]
}
champollion sync # sync i18n string files + content files
champollion sync --dry # preview changes without writing
コンテンツ翻訳の詳細
フロントマター: YAML(---)と TOML(+++)の両方の区切り文字をサポートしています。デフォルトで title、description、summary、subtitle、caption、linkTitle を翻訳します。その他のフィールド(date、draft、tags、weight、slug など)はそのまま保持されます。設定ファイルの translatableFields でカスタマイズできます。
ブロック保護: コードブロック、Hugo ショートコード、インラインコード、生の HTML は Unicode センチネルプレースホルダーを使用して自動的に保護されます。これらは変更されずにそのまま出力されます。
ファイル名の規則: Hugo の translation-by-filename パターンに従います:
my-post.md→my-post.fr.mdmy-post.en.md→my-post.fr.md(ソースのサフィックスを除去)
既存ファイルのスキップ: 既存の翻訳済みファイルは上書きされません。再翻訳を強制するには、対象ファイルを削除してください。
複数形
TOML および YAML ロケールは CLDR の複数形をサポートしています:
[items]
one = "{{ .Count }} item"
other = "{{ .Count }} items"
内部的には差分処理のために items.one と items.other として表現され、書き込み時に正しいセクション形式に再シリアライズされます。
next-intl (JSON)
プロジェクト構成
my-app/
├── messages/
│ └── en.json ← source of truth
├── src/
│ ├── i18n/
│ │ ├── routing.ts
│ │ └── request.ts
│ └── middleware.ts
└── .env.local
セットアップ
npm install --save-dev champollion
{
"version": 3,
"inputLocale": "en",
"localesDir": "./messages",
"languages": ["fr", "de", "ja", "es", "ko", "zh", "pt", "ar"]
}
npx champollion sync
messages/fr.json、messages/ja.json などが生成されます。ネストされたキー構造を保持したまま完全に翻訳され、next-intl が自動的に読み込みます。
開発ワークフロー
{
"scripts": {
"dev": "champollion watch & next dev",
"i18n:sync": "champollion sync",
"i18n:audit": "champollion audit"
}
}
react-i18next (JSON)
フラットなファイル構成(推奨)
locales/
├── en.json
├── fr.json
└── ja.json
{
"version": 3,
"inputLocale": "en",
"localesDir": "./locales",
"languages": ["fr", "de", "ja"]
}
npx champollion sync
ネストされたディレクトリ構成
{locale}/{namespace}.json 構成を使用している場合は、フラット化 → 翻訳 → アンフラット化を行う同期スクリプトを作成してください。詳細は react-i18next のドキュメント を参照してください。