Что такое генератор чтения WordPress?
Генератор WordPress readme строит файл readme.txt, который читает каталог плагина WordPress.org, чтобы создать публичный список плагина. вы заполняете поля заголовка и разделы, и он выпускает файл в точном формате, который анализирует каталог - `=== Название плагина ===`, блок заголовка, разделенный двоеточием, и тела `==Section ==` - с живым предварительным просмотром рядом с ним, показывающим, как будет выглядеть страница листинга.
Формат суетливый в способах, которые невидимы, пока что-то не не так. `Stable tag` называет версию, которую на самом деле обслуживает каталог, поэтому неправильный или отсутствующий тег отправляет ничего независимо от того, что вы совершили. `Tested up to` - это то, что производит предупреждение "непроверено с вашей версией WordPress" в списке, когда он отстает от ядра. `Tags` индексирует первые пять и молча игнорирует остальные. краткое описание сокращается до 150 символов в результатах поиска. Ни один из них не вызывает ошибки, которую вы видите при написании файла; они создают список, который выглядит неправильно, или загрузку, которая не происходит, несколько дней спустя. Этот инструмент устанавливает каждый предел рядом с полем, которому он принадлежит, и перечисляет, что каталог будет делать с вашим файлом перед его загрузкой.
Все работает на стороне клиента. ничего не загружается, никакая учетная запись не создается, и черновик хранится в вашем собственном браузере, поэтому перезагрузка не теряет его. вы также можете импортировать существующий readme.txt - вставить в тот, который уже поставляется вашим плагином, и он анализируется обратно в форму, что является самым быстрым способом исправить старый файл или привести readme в соответствие с текущими требованиями без его перепечатки. разделы в необычном порядке, строки заголовка этот инструмент не моделирует, и непоследовательный интервал все читаются, а не отказываются, потому что это то, как выглядят реальные файлы readme.
Две вещи, которые не может нести сам файл, стоит сказать прямо.Banner и иконки изображения не являются частью readme.txt: они живут в папке плагина `/assets/` как `banner-1544x500.png` и `icon-256x256.png`, и поля здесь существуют, поэтому предварительный просмотр показывает список, который вы действительно получите.Screenshots работают так же - readme.txt несет пронумерованные подписи, а соответствующие файлы `screenshot-1.png` идут в `/assets/` в таком порядке.Предварительный просмотр честен по этому поводу, а не притворяется, что URL-адрес изображения в форме появится на WordPress.org. Как только файл будет прав, скачайте его, опустите в корень плагина и зафиксируйте в багажнике вашего репозитория SVN.
Как использовать генератор WordPress readme?
Заполнить заголовки
Имя плагина, имена пользователей WordPress.org участников, стабильный тег, поддерживаемые версии WordPress и PHP и до пяти тегов. Они становятся заголовком, сначала блокируют анализ каталога.
Напишите описание
Одно короткое предложение для списка поиска, затем длинное описание в Markdown - # заголовки, **жирный** и * перечисляет все рендеринг на странице плагина. Предварительный просмотр рядом с формой обновляется по мере ввода.
Добавить часто задаваемые вопросы, скриншоты и журнал изменений
Каждый FAQ становится своим = вопрос = блок. подписи к снимку экрана нумеруются, чтобы соответствовать скриншоту-1.png файлов в папке активов. журнал изменений принимает один = версия = блок за выпуск, сначала самый новый.
Проверьте предупреждения, затем загрузите
Прочтите "Что бы каталог сделал с этим" - отсутствующий стабильный тег, слишком длинное краткое описание, теги мимо пятого - затем загрузите readme.txt и зафиксируйте его в багажнике вашего плагина.
Основные характеристики
Предварительный просмотр каталога Live
Баннер, значок, вкладки и боковая панель списка WordPress.org, отображаемые из ваших полей по мере ввода, поэтому вы видите страницу перед ее публикацией.
Импортировать существующий readme.txt
Анализирует чтение, которое вы уже отправляете обратно в форму, включая разделы в необычном порядке и строки заголовков, которые этот инструмент не моделирует.
Собственные ограничения каталога, указано
Пять индексированных тегов, 150-символьное краткое описание, стабильный тег, который определяет, какие корабли - каждый из которых показан в поле, к которому он применяется, и обобщен перед загрузкой.
Уменьшите, где каталог принимает это
Заголовки, выделенные жирным шрифтом, списки и ссылки отображаются в описании, установке и журнале изменений точно так же, как и на странице плагина.
Frequently Asked Questions
Related Tools
WordPress Plugin Detector
See which WordPress plugins load on any page, with the folder slug, the version, the install count and the evidence each one came from.
WordPress Theme Detector
Find out which WordPress theme a site runs, with the version, the author, the parent theme and the evidence each answer came from.
Markdown Table Generator
Build Markdown tables in a spreadsheet-style editor - import CSV, Excel, or an existing table, set alignment, copy clean GFM
Markdown TOC Generator
Generate a linked table of contents from Markdown headings
Comments
0 comments
No comments yet. Be the first to share your thoughts!