Skip to main content

A plugin’s README is the first thing users read on the Dify Marketplace detail page. Adding translations lets non-English users read your docs in their own language without losing the original.

File Specifications#

LanguageRequiredFilenamePath
EnglishYesREADME.mdPlugin root
Simplified ChineseNoREADME_zh_Hans.mdreadme/
JapaneseNoREADME_ja_JP.mdreadme/
Portuguese (Brazil)NoREADME_pt_BR.mdreadme/

All files must be UTF-8 encoded. The English README.md always stays in the plugin root; every other language goes inside a readme/ subdirectory.

Keep READMEs concise, under ~500 words. The Marketplace detail page surfaces the README directly, so optimize it for someone evaluating whether to install:

Avoid putting a full API reference or development notes in the README; those belong in source comments or a separate docs site. The Marketplace audience is end users picking a plugin, not contributors reading your codebase.

How the Marketplace Picks a Language#

When a visitor opens your plugin’s detail page, the Marketplace looks for a README matching their UI language. If a match exists in the readme/ directory, it renders that file. Otherwise it falls back to the English README.md.

Plugin Detail Page in English

Note

Language codes are matched exactly: README_zh_Hans.md serves Simplified Chinese only; Traditional Chinese users see the English fallback.