Skip to content

インテグレーション

ドキュメントサイトやAstroプロジェクトにai-i18n-toolsを組み込むための、フレームワーク固有のガイドです。各インテグレーションは、ページコンテンツにDocumentsパイプライン (translate-docs / sync) を使用します。シェル文字列 (ナビゲーション、サイドバー、テーマ) は、注記がある場合は同じパイプライン内で処理され、別のJSONパイプラインは経由しません。

読むべきガイド

あなたのサイト初期テンプレートここから開始
Astro StarlightまたはプレーンなAstroui-starlight / ハイブリッドUI文字列Astro
Docusaurusui-docusaurusDocusaurus
VitePressui-vitepressVitePress
Nextra 4 (Next.js App Router)ui-nextraNextra
Fumadocs 4 (Next.js App Router)ui-fumadocsFumadocs

共通の概念

すべてのドキュメントフレームワークのインテグレーションは、Documentsで説明されている同じdocs[]ブロックモデルを共有しています。フレームワークに合わせてdocsOutput.styleを設定します ("docusaurus", "vitepress", "nextra", "fumadocs", または "astro-starlight")。出力フォルダのレイアウトとリンクの書き換え動作については、Output layoutsLink rewritingを参照してください。

init -t ui-* テンプレートは、デフォルトの LLM プロバイダーブロック (-P <provider> を渡さない限り openrouter) をスキャフォールディングします。translate-docs または sync の前に、必要に応じて provider / providers を設定し、対応する API キーを設定してください — プロバイダーと API キー を参照してください。

フレーム間比較については、フレームワークシェルの翻訳を参照してください。以下にリンクされている各ガイドでは、そのフレームワークのセットアップについて説明しています。

フレームワークシェルの翻訳

フレームワークシェル / テーマ文字列パイプライン
Docusauruswrite-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
Fumadocsmeta.json サイドバーラベルドキュメント — style: "fumadocs" + translate-docs の時に自動
FumadocsUIオーバーライドカタログドキュメント — docsOutput.fumadocsUiCatalog + translate-docs
Astro Starlight組み込みUI文字列(多数のロケール)、追加のシェルパイプラインなしドキュメント — translate-docs (ページのみ)

json[]にフレームワークシェル/テーマ文字列を入れないでputください — そのパイプラインは、関連のないアプリロケールバンドル用です。フレームワークごとのセットアップ詳細については、読むべきガイドはどれからリンクされているガイドを参照してください。

実行可能な例

フレームワークリポジトリの例
Astro Starlightexamples/astro-docs
プレーンなAstroウェブサイトexamples/astro-website
Docusaurusexamples/docusaurus-docs
VitePressexamples/vitepress-docs
Nextraexamples/nextra-docs
Fumadocsexamples/fumadocs-docs

MITライセンスの下で公開されています。