Qu'est-ce qu'un générateur WordPress readme ?
Un générateur de lecture WordPress construit le fichier readme.txt que lit le répertoire du plugin WordPress.org pour créer la liste publique d'un plugin. Vous remplissez les champs d'en-tête et les sections, et il émet le fichier dans le format exact analysé par le répertoire - le `.`=== Plugin Name ===`, the colon-separated header block, and the ` `== Section =` bodies - with a live preview abside it show what the listing page will look like.
Le format est difficile d'une manière invisible jusqu'à ce que quelque chose ne va pas. `Stable tag` names the version the directory really serves, donc une balise erronée ou manquante n'expédie rien, peu importe ce que vous avez commis. `Tested up to` is what produce the « untested with your version of WordPress » warning on the listing when it lagardshind core. `Tags` the first to the field it belload it who do do with the listing and lists.
Tout s'exécute côté client Rien n'est téléchargé, aucun compte n'est créé, et le brouillon est conservé dans votre propre navigateur pour qu'un rechargement ne le perde pas Vous pouvez également importer un readme.txt existant - coller dans celui que votre plugin expédie déjà et il est réanalysé dans le formulaire, ce qui est le moyen le plus rapide de fixer un ancien fichier ou de mettre un readme aux exigences actuelles sans le retaper. Sections dans un ordre inhabituel, lignes d'en-tête cet outil ne modélise pas, et l'espacement incohérent sont tous lus plutôt que refusés, car c'est à cela que ressemblent les vrais fichiers readme.
Deux choses que le fichier lui-même ne peut pas transporter valent la peine d'être dites clairement Les images de bannières et d'icônes ne font pas partie de readme.txt : elles vivent dans le dossier `/assets/` as `banner-1544x500.png` et `icon-256x256.png`, et les champs ici existent donc l'aperçu montre la liste que vous obtiendrez réellement Les captures d'écran fonctionnent de la même manière - readme.txt transporte les légendes numérotées, et les fichiers `shot-1.png` correspondent à `less trunk trunk order this right URL, trust.Press downloading it is happing the firm.
Comment utiliser le générateur WordPress readme ?
Remplissez les titres
Le nom du plugin, les noms d'utilisateur WordPress.org des contributeurs, la balise stable, les versions WordPress et PHP que vous prenez en charge et jusqu'à cinq balises Ceux-ci deviennent le bloc d'en-tête que le répertoire analyse en premier.
Écrire la description
Une courte phrase pour la liste de recherche, puis la longue description dans Markdown - ## heads, **bold** et * répertorie tous les rendus sur la page du plugin. L'aperçu à côté des mises à jour du formulaire au fur et à mesure que vous tapez.
Ajouter FAQ, captures d'écran et changelog
Chaque FAQ devient la sienne = question = bloc Les légendes des captures d'écran sont numérotées pour correspondre aux fichiers screenshot-1. png de votre dossier d'actifs Le journal des modifications prend une = version = bloc par version, la plus récente en premier.
Vérifiez les avertissements, puis téléchargez
Lisez « Ce que le répertoire ferait avec ça » - une balise stable manquante, une courte description trop longue, les balises au-delà de la cinquième - puis téléchargez readme.txt et commettez-le dans le tronc de votre plugin.
Principales caractéristiques
Aperçu direct du répertoire
La bannière, l'icône, les onglets et la barre latérale d'une liste WordPress.org, rendus à partir de vos champs au fur et à mesure que vous tapez, afin que vous voyiez la page avant de la publier.
Importer un readme.txt existant
Analyse un readme que vous renvoyez déjà dans le formulaire, y compris les sections dans un ordre inhabituel et les lignes d'en-tête que cet outil ne modélise pas.
Les propres limites du répertoire, précisez-le
Cinq balises indexées, une brève description de 150 caractères, une balise stable qui décide de ce qui est livré - chacune affichée dans le champ auquel elle s'applique et résumée avant le téléchargement.
Marquage où le répertoire l'accepte
Les titres, les caractères gras, les listes et les liens s'affichent dans la description, l'installation et le journal des modifications exactement comme ils le feront sur la page du plugin.
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!