Использование файла readme.md для плагина на WordPress.org
А знаете ли вы, что плагин, размещенный в каталоге WordPress.org, может использовать markdown файл разметки readme.md
вместо readme.txt
?
Если вы размещаете свой плагин на GitHub или GitLab и используете файл readme.md
, нет необходимости поддерживать или создавать отдельный файл readme.txt
— просто отправьте файл readme.md
прямо на wordpress.org.
Есть некоторые предостережения:
- Маркдаун со вкусом GitHub не поддерживается – используйте обычный синтакис.
- Бейджи со статусами коряво обрезаются на wordpress.org.
- Скриншоты нужно форматировать определенным образом.
- Не забывайте, что в конце каждого заголовка должны стоять два пробела (
Stable tag:
и тд), чтобы разрывы строк отображались правильно на GitHub.