インテグレーション
ドキュメントサイトやAstroプロジェクトにai-i18n-toolsを組み込むための、フレームワーク固有のガイドです。各インテグレーションは、ページコンテンツにDocumentsパイプライン (translate-docs / sync) を使用します。シェル文字列 (ナビゲーション、サイドバー、テーマ) は、注記がある場合は同じパイプライン内で処理され、別のJSONパイプラインは経由しません。
読むべきガイド
| あなたのサイト | 初期テンプレート | ここから開始 |
|---|---|---|
| Astro StarlightまたはプレーンなAstro | ui-starlight / ハイブリッドUI文字列 | Astro |
| Docusaurus | ui-docusaurus | Docusaurus |
| VitePress | ui-vitepress | VitePress |
| Nextra 4 (Next.js App Router) | ui-nextra | Nextra |
| Fumadocs 4 (Next.js App Router) | ui-fumadocs | Fumadocs |
共通の概念
すべてのドキュメントフレームワークのインテグレーションは、Documentsで説明されている同じdocs[]ブロックモデルを共有しています。フレームワークに合わせてdocsOutput.styleを設定します ("docusaurus", "vitepress", "nextra", "fumadocs", または "astro-starlight")。出力フォルダのレイアウトとリンクの書き換え動作については、Output layoutsとLink rewritingを参照してください。
各 init -t ui-* テンプレートは、デフォルトの LLM プロバイダーブロック (-P <provider> を渡さない限り openrouter) をスキャフォールディングします。translate-docs または sync の前に、必要に応じて provider / providers を設定し、対応する API キーを設定してください — プロバイダーと API キー を参照してください。
フレーム間比較については、フレームワークシェルの翻訳を参照してください。以下にリンクされている各ガイドでは、そのフレームワークのセットアップについて説明しています。
フレームワークシェルの翻訳
| フレームワーク | シェル / テーマ文字列 | パイプライン |
|---|---|---|
| Docusaurus | write-translations カタログ ({ message, description }) | ドキュメント — docs[].docusaurusCatalogDir + translate-docs |
| VitePress | テーマ/ナビ/サイドバーカタログ | ドキュメント — docsOutput.vitepressThemeCatalog + translate-docs |
| Nextra | _meta.ts サイドバーラベル | ドキュメント — style: "nextra" + translate-docs の時に自動 |
| Nextra | テーマ辞書 .ts | ドキュメント — docs[].nextraDictionaryPath + translate-docs |
| Fumadocs | meta.json サイドバーラベル | ドキュメント — style: "fumadocs" + translate-docs の時に自動 |
| Fumadocs | UIオーバーライドカタログ | ドキュメント — docsOutput.fumadocsUiCatalog + translate-docs |
| Astro Starlight | 組み込みUI文字列(多数のロケール)、追加のシェルパイプラインなし | ドキュメント — translate-docs (ページのみ) |
json[]にフレームワークシェル/テーマ文字列を入れないでputください — そのパイプラインは、関連のないアプリロケールバンドル用です。フレームワークごとのセットアップ詳細については、読むべきガイドはどれからリンクされているガイドを参照してください。
実行可能な例
| フレームワーク | リポジトリの例 |
|---|---|
| Astro Starlight | examples/astro-docs |
| プレーンなAstroウェブサイト | examples/astro-website |
| Docusaurus | examples/docusaurus-docs |
| VitePress | examples/vitepress-docs |
| Nextra | examples/nextra-docs |
| Fumadocs | examples/fumadocs-docs |