メインコンテンツへスキップ

フレームワーク統合

人気のフレームワークで champollion をセットアップするための手順です。

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
champollion.config.json
{
"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(+++)の両方の区切り文字をサポートしています。デフォルトで titledescriptionsummarysubtitlecaptionlinkTitle を翻訳します。その他のフィールド(date、draft、tags、weight、slug など)はそのまま保持されます。設定ファイルの translatableFields でカスタマイズできます。

ブロック保護: コードブロック、Hugo ショートコード、インラインコード、生の HTML は Unicode センチネルプレースホルダーを使用して自動的に保護されます。これらは変更されずにそのまま出力されます。

ファイル名の規則: Hugo の translation-by-filename パターンに従います:

  • my-post.mdmy-post.fr.md
  • my-post.en.mdmy-post.fr.md(ソースのサフィックスを除去)

既存ファイルのスキップ: 既存の翻訳済みファイルは上書きされません。再翻訳を強制するには、対象ファイルを削除してください。

複数形

TOML および YAML ロケールは CLDR の複数形をサポートしています:

[items]
one = "{{ .Count }} item"
other = "{{ .Count }} items"

内部的には差分処理のために items.oneitems.other として表現され、書き込み時に正しいセクション形式に再シリアライズされます。