README は、ユーザーが Dify マーケットプレイス の詳細ページで最初に目にする内容です。翻訳を追加すると、英語以外のユーザーが原文を失うことなく自分の言語でドキュメントを読めます。
ファイル仕様
| 言語 | 必須 | ファイル名 | パス |
|---|
| 英語 | はい | README.md | プラグインルート |
| 簡体字中国語 | いいえ | README_zh_Hans.md | readme/ |
| 日本語 | いいえ | README_ja_JP.md | readme/ |
| ポルトガル語(ブラジル) | いいえ | README_pt_BR.md | readme/ |
すべてのファイルは UTF-8 でエンコードする必要があります。英語の README.md は常にプラグインルートに置き、それ以外の言語はすべて readme/ サブディレクトリ内に配置します。
your_plugin/
├── README.md
├── readme/
│ ├── README_zh_Hans.md
│ ├── README_ja_JP.md
│ └── README_pt_BR.md
├── manifest.yaml
├── main.py
└── ...
推奨される構成
README は簡潔に、500 ワード程度以内に保ちます。マーケットプレイスの詳細ページは README をそのまま表示するため、インストールするかどうかを検討しているユーザーに向けて最適化します。
# Plugin Name
One-sentence summary of what the plugin does.
## Features
- Key capability 1
- Key capability 2
- Key capability 3
## Setup
1. Where to get the credentials (link to the upstream service).
2. Where to paste them in Dify.
## Usage
A minimal example — for a tool, show the inputs and outputs. For a model
provider, show the model selector. Screenshots help.
## Privacy
Briefly describe what data the plugin sends to third parties. Link to your
PRIVACY.md.
完全な API リファレンスや開発メモを README に含めないでください。それらはソースコードのコメントや別途用意するドキュメントサイトに記載します。マーケットプレイスの読者は、プラグインを選ぶエンドユーザーであり、コードベースを読む貢献者ではありません。
マーケットプレイスによる言語の選択方法
訪問者がプラグインの詳細ページを開くと、マーケットプレイスは UI 言語に一致する README を探します。readme/ ディレクトリに一致するものがあればそのファイルを表示し、なければ英語の README.md にフォールバックします。
言語コードは厳密に一致します。README_zh_Hans.md は簡体字中国語のみに対応し、繁体字中国語のユーザーには英語のフォールバックが表示されます。
このページを編集する | 問題を報告する