インテグレーション
フレームワーク連携のリファレンス:共通点とシェル文字列の違い。サイトに言語を追加するには、ウェブサイトまたはドキュメントサイトにi18nを追加するから始めます。アプリケーションの場合は、JS/TSアプリにi18nを追加する、Pythonアプリにi18nを追加する、または.NETアプリにi18nを追加するから始めます。リポジトリのREADMEやその他のMarkdownファイルの場合は、READMEとMarkdownドキュメントにi18nを追加するから始めます。
ドキュメント統合では、ページコンテンツ用にドキュメントパイプライン(translate-docs / sync)を使用します。シェル文字列(ナビゲーション、サイドバー、テーマ)は、注記がある場合は、別のJSONパイプライン経由ではなく、同じパイプライン内で処理されます。Pythonアプリケーションでは、UI文字列パイプライン(extract / translate-ui)を使用します。
読むべきガイド
フレームワークごとに1つの初期化テンプレートを備えた選択テーブルは、ウェブサイトまたはドキュメントサイトにi18nを追加する にあります。そのページのウォークスループロンプトは、フレームワークのi18nを有効にします。以下の統合ページには、シェルカタログの詳細が記載されています。Pythonフレームワーク: Python。
共通の概念
ドキュメントフレームワークの統合では、Documentsで説明されているものと同じdocs[]ブロックモデルを共有します。docsOutput.styleを自身のフレームワーク("docusaurus"、"vitepress"、"nextra"、"fumadocs"、または"astro-starlight")に合わせて設定してください。出力フォルダーのレイアウトとリンク書き換えの動作については、Output layoutsおよびLink rewritingを参照してください。Pythonのセットアップは別個に行います:Python。
各init -t ui-* -P <provider>スキャフォールドは、そのプリセットの大規模言語モデルプロバイダーブロックを書き込みます。translate-docsまたはsyncの前に、一致するエーピーアイキーを設定してください。詳しくはプロバイダーとエーピーアイキーを参照してください。
フレーム間比較については、フレームワークシェルの翻訳を参照してください。以下にリンクされている各ガイドでは、そのフレームワークのセットアップについて説明しています。
フレームワークシェルの翻訳
| フレームワーク | シェル / テーマ文字列 | パイプライン |
|---|---|---|
| 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 |
| Streamlit | examples/python-streamlit |
| Flask | examples/python-flask |
| FastAPI | examples/python-fastapi |
| GNU gettext | examples/python-gettext |
| .NET JSONヘルパー | examples/dotnet-console |
| .NET ResourceManagerヘルパー | examples/dotnet-resx |