Was ist ein WordPress Readme Generator?
Ein WordPress-Readme-Generator erstellt die readme.txt-Datei, die das WordPress.org-Plugin-Verzeichnis liest, um die öffentliche Auflistung eines Plugins zu erstellen. Sie füllen die Header-Felder und Abschnitte aus und senden die Datei im genauen Format aus, das Verzeichnis analysiert - das `===Plugin Name ===Woint-Titel, der durch Doppelpunkte getrennte Header-Block und die `== Section ==` Bodies - mit einer Live-Vorschau daneben, die zeigt, wie die Listing-Seite aussehen wird.
Das Format ist auf eine Weise wählerisch, die unsichtbar ist, bis etwas nicht stimmt. „`Stable tag`" nennt die Version, der das Verzeichnis tatsächlich dient, also liefert ein falsches oder fehlendes Tag nichts, egal was Sie begangen haben. „wailistTested up to`" ist das, was die Warnung „untested with your Version of WordPress" auf dem Eintrag erzeugt, wenn es hinter dem Kern zurückbleibt. „wailTags` indiziert die ersten fünf und ignoriert den Rest stillschweigend. Die Kurzbeschreibung wird in den Suchergebnissen auf 150 Zeichen gekürzt. Keine davon führt einen Fehler aus, den Sie beim Schreiben der Datei sehen; Sie erstellen Tage später einen Eintrag, den Sie herunterladen. Dieses Tool gibt an, und listet Sie mit Ihrem Verzeichnis auf, zu dem Sie es herunterladen.
Alles läuft clientseitig Es wird nichts hochgeladen, es wird kein Konto erstellt, und der Entwurf wird in Ihrem eigenen Browser aufbewahrt, damit ein Reload ihn nicht verliert Sie können auch eine vorhandene readme.txt importieren - fügen Sie in die ein, die Ihr Plugin bereits versendet und sie wird wieder in das Formular geparst, was die schnellste Möglichkeit ist, eine alte Datei zu reparieren oder eine Readme auf aktuelle Anforderungen zu bringen, ohne sie neu einzugeben Abschnitte in ungewöhnlicher Reihenfolge, Headerzeilen, die dieses Tool nicht modelliert, und inkonsistente Abstände werden alle gelesen und nicht abgelehnt, denn so sehen echte Readme-Dateien aus.
Zwei Dinge, die die Datei selbst nicht tragen kann, sind es wert, klar gesagt zu werden Banner- und Symbolbilder sind nicht Teil von readme.txt: Sie leben im Ordner `/assets/` des Plugins als 1544x500.png` und `-256x256.png`, und die Felder hier existieren, sodass die Vorschau die Auflistung anzeigt, die Sie tatsächlich erhalten werden Screenshots funktionieren auf die gleiche Weise - readme.txt trägt die nummerierten Beschriftungen und die passenden 1.png`-Dateien werden in dieser Reihenfolge in /assets/`/` angezeigt. Die Vorschau ist ehrlich zu dieser Datei, anstatt sie auf WordPressorg herunterzuladen, wird die WordPress-Plugin-Plugin-Plugin-n-on-on-on-commit-on-on-on-t-Plugin-on-commit-on-on-on-t-commit-on-on-on-on-on-on-commit-on-on-on-c-commit-c-on-on-c-c-on-c-commit-c-c-c-on-on-on-c-c-c-on-on-c-c-c-c-c-
Wie benutzt man den WordPress Readme Generator?
Füllen Sie die Überschriften aus
Der Plugin-Name, die WordPress.org-Benutzernamen der Mitwirkenden, das stabile Tag, die von Ihnen unterstützten WordPress - und PHP-Versionen und bis zu fünf Tags Diese werden zum Header-Block, der zuerst das Verzeichnis analysiert.
Schreibe die Beschreibung
Ein kurzer Satz für die Suchliste, dann die lange Beschreibung in Markdown - ## Überschriften, **fett** und * listet alle Render auf der Plugin-Seite auf Die Vorschau neben dem Formular aktualisiert sich beim Tippen.
FAQ, Screenshots und Changelog hinzufügen
Jede FAQ wird zu ihrer eigenen = Frage = Block. Bildschirmfoto-Untertitel werden nummeriert, um mit den Screenshot-1.png-Dateien in Ihrem Assets-Ordner übereinzustimmen. Der Changelog nimmt eine = Version = Block pro Release, neuste zuerst.
Überprüfen Sie die Warnungen und laden Sie sie dann herunter
Lesen Sie "Was das Verzeichnis damit machen würde" - ein fehlendes stabiles Tag, eine überlange Kurzbeschreibung, Tags über das fünfte hinaus - dann laden Sie readme.txt herunter und legen Sie es auf den Trunk Ihres Plugins fest.
Hauptmerkmale
Live-Verzeichnisvorschau
Das Banner, das Symbol, die Registerkarten und die Seitenleiste einer WordPress.org-Liste werden beim Eingeben aus Ihren Feldern gerendert, sodass Sie die Seite sehen, bevor Sie sie veröffentlichen.
Importieren Sie eine vorhandene readme.txt
Parst eine Readme, die Sie bereits zurück in das Formular senden, einschließlich Abschnitten in einer ungewöhnlichen Reihenfolge und Header-Zeilen, die dieses Tool nicht modelliert.
Die eigenen Grenzen des Verzeichnisses, angegeben
Fünf indizierte Tags, eine 150-stellige Kurzbeschreibung, ein stabiles Tag, das entscheidet, was versendet wird - jedes wird auf dem Feld angezeigt, auf das es zutrifft, und vor dem Download zusammengefasst.
Markdown, wo das Verzeichnis es akzeptiert
Überschriften, Fettdruck, Listen und Links werden in der Beschreibung, Installation und dem Changelog genau so wiedergegeben, wie sie auf der Plugin-Seite aussehen.
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!