Command Palette

Search for a command to run...

WO

WordPress Readme Generator

Schrijf een plugin readme.txt de WordPress.org directory parseert, met een live preview van de listing die het produceert en een download wanneer het goed is.

Wat is een WordPress readme generator?

Een WordPress readme generator bouwt het readme.txt bestand dat de WordPress.org plugin directory leest om een plugin's openbare vermelding te maken U vult de header velden en de secties in, en het zendt het bestand uit in het exacte formaat dat de directory parseert - de `=== Plugin Name ===` title, het colon-separated header block, en de `== Section ==` bodies - met een live preview ernaast die laat zien hoe de advertentiepagina eruit zal zien.

Het formaat is kieskeurig op manieren die onzichtbaar zijn totdat er iets mis is. `Stable tag` names the version the directory actual serves, so a wrong or missing tag ships nothing no matter what you committed. `Tested up to` is what produceert de "niet-getest met je versie van WordPress" waarschuwing op de lijst wanneer deze achterblijft bij core. `Tags` indexeert de eerste vijf en negeert stil de rest De korte beschrijving wordt in de zoekresultaten op 150 tekens geknipt Geen van deze geeft een fout die je ziet tijdens het schrijven van het bestand; ze produceren een lijst die er verkeerd uitziet of een download die niet gebeurt, dagen later Deze tool vermeldt elke limiet naast het veld waartoe het behoort, en geeft de lijst met het bestand waarin je directory zou doen.

Alles draait client-side Niets wordt geüpload, er wordt geen account aangemaakt, en het concept wordt in uw eigen browser bewaard zodat een herlaad niet verliest U kunt ook een bestaande readme.txt importeren - plakken in degene die uw plugin al verzendt en het wordt terug geparseerd in het formulier, wat de snelste manier is om een oud bestand te repareren of een readme aan de huidige vereisten te brengen zonder het opnieuw te typen Secties in een ongebruikelijke volgorde, headerregels die deze tool niet modelleert, en inconsistente spatiëring worden allemaal gelezen in plaats van geweigerd, want dat is hoe echte readme-bestanden eruit zien.

Twee dingen die het bestand zelf niet kan dragen zijn de moeite waard om duidelijk te zeggen Banner - en pictogramafbeeldingen maken geen deel uit van readme.txt: ze leven in de map `/assets/` van de plugin als `banner-1544x500.png` en `icon-256x256.png`, en de velden hier bestaan dus de preview toont de lijst die je daadwerkelijk krijgt Screenshots werken op dezelfde manier - readme.txt draagt de genummerde bijschriften, en de bijpassende `screenshot-1.png`-bestanden gaan in 'till downloaden/assets/de-vergeven het in die volgorde De preview gaat over dit bestand in plaats van een préen.

Hoe de WordPress readme generator gebruiken?

  1. Vul de kopjes in

    De plugin naam, de WordPress.org gebruikersnamen van de bijdragers, de stabiele tag, de WordPress en PHP versies die u ondersteunt, en maximaal vijf tags Dit worden de headerblokkeer de directory parseert eerst.

  2. Schrijf de beschrijving

    Eén korte zin voor de zoeklijst, daarna de lange beschrijving in Markdown - ## koppen, **vet** en * geeft een overzicht van alle renders op de plug-inpagina. Het voorbeeld naast het formulier wordt bijgewerkt terwijl u typt.

  3. Voeg FAQ, screenshots en changelog toe

    Elke FAQ wordt zijn eigen = vraag = blok Screenshot bijschriften zijn genummerd om overeen te komen met de screenshot-1. png bestanden in uw assets map De changelog neemt een = versie = blok per release, nieuwste eerst.

  4. Controleer de waarschuwingen en download deze vervolgens

    Lees "Wat de directory hiermee zou doen" - een ontbrekende stabiele tag, een te lange korte beschrijving, tags voorbij de vijfde - download vervolgens readme.txt en zet deze in de trunk van uw plug-in.

Belangrijkste kenmerken

  • Preview van live directory

    De banner, het pictogram, de tabbladen en de zijbalk van een WordPress.org-lijst, weergegeven vanuit uw velden terwijl u typt, zodat u de pagina ziet voordat u deze publiceert.

  • Importeer een bestaande readme.txt

    Parseert een readme die u al verzendt terug naar het formulier, inclusief secties in een ongebruikelijke volgorde en kopregels die deze tool niet modelleert.

  • De eigen limieten van de directory, vermeld

    Vijf geïndexeerde tags, een korte beschrijving van 150 tekens, een stabiele tag die bepaalt welke schepen worden verzonden - elk weergegeven in het veld waarop het van toepassing is, en samengevat voordat het wordt gedownload.

  • Afwaardering waar de directory het accepteert

    Kopjes, vetgedrukt, lijsten en links worden in de beschrijving, installatie en changelog precies weergegeven zoals op de plug-inpagina.

Frequently Asked Questions

Ja, het is gratis en hoeft niet te worden aangemeld. Het draait aan de clientzijde in uw browser, dus er is geen server die het werk doet en er hoeft niets te worden opgeladen.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

wordpress readme generatorreadme.txt generatorplugin readme generatorwordpress plugin readmereadme txt wordpress plugingenerate readme for wordpress pluginwordpress readme validatorplugin directory listing