diff --git a/README.ja-JP.md b/README.ja-JP.md new file mode 100644 index 00000000..71675665 --- /dev/null +++ b/README.ja-JP.md @@ -0,0 +1,179 @@ +# ComfyUI ドキュメンテーション +| [English](./README.md) | [中文](./README.zh-CN.md) | [日本語](./README.ja-JP.md) | + +## 開発 + + +ドキュメントの変更をローカルでプレビューするには、まず依存関係をインストールし、次に開発サーバーを起動します: + +``` +npm i +npm run dev +``` + +### PRを作成する + +PRを作成してください。承認されると、Vercelが変更を https://docs.comfy.org/ にデプロイします。 + +### APIリファレンスドキュメントの生成 + +OpenAPIファイルまたはファイルを含むURLのいずれかを使用できます: + +```bash +cd registry/api-reference # APIファイルを製品ごとに分離しておく +npx @mintlify/scraping@latest openapi-file +``` + +これにより、各エンドポイントのMDXファイルのみが生成されます。これらのファイルへのリンクを`docs.json`に追加する必要があり、最新のAPI仕様がそのドキュメントページに表示されます。 + + +## ファイルの保存場所に関する特記事項 + +ドキュメント作成中に記事のパスを調整する必要があるため、これらのパスを変更すると、元々多数の記事やテンプレートで使用されているリンクがアクセス不能になる可能性があります。 +- ドキュメントディレクトリの構成は`docs.json`ファイルを通じて再編成できるため、絶対に必要な場合を除き、元のドキュメントのファイルの場所は変更しません。 +- 調整が必要な場合は、`docs.json`を変更してファイルを再編成してください。 +- 変更が不可欠な場合は、`docs.json`ファイルにリダイレクトルールを追加してください。 + +> **重要**: MDXファイルを移動または名前変更する場合は、`docs.json`ファイルにリダイレクトを追加する必要があります。GitHubアクションがリダイレクトをチェックし、不足している場合はPRを失敗させます。リダイレクトは次の形式に従う必要があります: +> ```json +> "redirects": [ +> { +> "source": "/path/to/old-file", +> "destination": "/path/to/new-file" +> } +> ] +> ``` +> `zh-CN`ディレクトリに対応する中国語翻訳ファイルを含めることも忘れないでください! + +## ビルトインノードドキュメントについて + +ComfyUIには、ビルトインノードとカスタムノードの両方に対応したビルトインノードヘルプメニューが搭載されました。すべてのビルトインノードドキュメントは、今後[このリポジトリ](https://github.com/Comfy-Org/embedded-docs)でメンテナンスされます。 + +### 同期頻度 + +コンテンツの同期と更新を確実にするため、対応するリポジトリから更新されたドキュメントを週に一度docs.comfy.orgに定期的に同期します。ドキュメントに貢献したい場合は、[このリポジトリ](https://github.com/Comfy-Org/embedded-docs)にPRと更新を提出してください。 + +### ノードドキュメントファイルの構成 + +ノードドキュメントについては、以下の理由から`built-in-node`フォルダの下に単一レベルのディレクトリ構造を使用します: +- ComfyUIはアップデート中にノードのカテゴリやディレクトリを調整する可能性があり、多階層のディレクトリ構造を使用するとノードドキュメントの頻繁な調整が必要になります +- これらの頻繁な調整は、リダイレクトやチェックを頻繁に追加する必要があることを意味します +- Mintlifyは`docs.json`ファイルでドキュメント階層を設定することをサポートしているため、そのファイルで統一的な変更を行うことができます + +> 歴史的な更新により、既存のドキュメントの一部は異なるフォルダ階層を使用しています。これらのファイルは今後調整しませんが、新しいファイルは単一レベルのディレクトリを使用します + +## 貢献 + +PRを作成していただければ、数日以内にレビューします。 + +または、[discord](https://discord.com/invite/comfyorg)でお話ししましょう。 + +このドキュメントはMintlifyで構築されています。使用方法については[Mintlifyのドキュメント](https://mintlify.com/docs)を参照してください。 + +### i18nへの貢献 + +Mintlifyはバージョニングを使用して他の言語を追加します。ページの翻訳を追加するには、次の手順に従ってください: + +1. 元の英語のファイル名とまったく同じファイル名で、言語コードの下にファイルを作成します。 + +たとえば、`introduction.mdx`を中国語に翻訳する場合、`zh-CN/get_started/introduction.mdx`の下にファイルを作成します。 + +ファイル編集の仕様については、[Mintlify](https://mintlify.com/docs/page)ドキュメントの「コンテンツの作成」セクションに記載されています。 + +> **重要**: 英語のドキュメントで既存のMDXファイルを変更する場合は、`zh-CN`ディレクトリ内の対応するファイルも更新する必要があります。GitHubアクションがこれを自動的にチェックし、対応する中国語の翻訳が更新されていない場合はPRを失敗させます。 + +2. `docs.json`のナビゲーションを更新する + +設定の詳細については、[Mintlifyローカリゼーション](https://mintlify.com/docs/navigation/localization)を参照してください。 + +単一のページを翻訳した場合は、新しく翻訳されたページのパスを対応する言語のナビゲーショングループに追加するだけで、その言語バージョンで表示されます。 + +`introduction.mdx`の場合: + +``` + "navigation": { + "languages": [ + { + "language": "en", + "groups": [ + { + "group": "Get Started", + "pages": [ + "get_started/introduction", + ... + ] + }, + ... + ] + }, + { + "language": "cn", + "groups": [ + { + "group": "開始行動", + "pages": [ + "zh-CN/get_started/introduction", + ... + ] + } + ] + } + ] + ... + } +``` + +Mintlifyは、`language`設定に基づいて、異なる言語バージョンで表示するページを自動的に決定します。 + +現在、Mintlifyは英語(en)、中国語(cn)、スペイン語(es)、フランス語(fr)、日本語(jp)、ポルトガル語(pt)、ブラジルポルトガル語(pt-BR)、ドイツ語(de)のローカリゼーションをサポートしています。 + +詳細については、[Mintlifyローカリゼーション](https://mintlify.com/docs/navigation/localization)に関するMintlifyのドキュメントを参照してください。 + +#### 新しい言語の追加 + +まだ言語が存在しない場合、たとえば`introduction.mdx`のフランス語翻訳を追加したい場合は、ルートディレクトリに新しい`fr-FR`フォルダを作成し、翻訳を完了してから、`docs.json`の`languages`の下に次のコンテンツを追加します: + +``` +{ + "languages": [ + ... + { + "language": "fr", + "groups": [ + { + "group": "Get Started", + "pages": [ + "fr-FR/get_started/introduction", + ... + ] + } + ] + } + ] +} +``` + +ロケールはMintlifyのデフォルトUIコンポーネントのテキストを翻訳します。これはオプションです。ロケールの完全なリストは[こちら](https://mintlify.com/docs/settings/global#param-locale)です。 + +#### 貢献ワークフローの例 + +ドキュメントにワークフローの例を追加する場合: + +1. ComfyUIからの出力(PNG、WebP)を取得し、モデルのURLをワークフローに追加して、ユーザーがワークフローをドラッグインしたときにそれらを利用できるようにします。この[ツール](https://comfyui-embeded-workflow-editor.vercel.app/)を使用して、PNGまたはWebPファイルのメタデータを編集できます。 + +[![ビデオタイトル](https://img.youtube.com/vi/_zYbP8w7G8A/0.jpg)](https://youtu.be/_zYbP8w7G8A) + +1. ワークフローのJSONとプレビュー画像を[example_workflowsリポジトリ](https://github.com/Comfy-Org/example_workflows)にアップロードします。 +1. ドキュメントでは、生のGitHubコンテンツURLを使用します。GitHubファイルURLを生コンテンツURLに変換するには: + - GitHubファイルURLから始めます: + ``` + https://github.com/Comfy-Org/example_workflows/blob/main/your-workflow.json + ``` + - それをraw.githubusercontent.comに変更し、'/blob'を削除します: + ``` + https://raw.githubusercontent.com/Comfy-Org/example_workflows/main/your-workflow.json + ``` + + GitHubのファイルページで「Raw」ボタンをクリックして、URLを直接コピーすることもできます。 + +これにより、ComfyUIにドラッグしたときに、ワークフローのメタデータがドキュメントサイトで保持されるようになります。