WPReadme Preview 2026
Development.
WPReadme Preview is a free online tool that renders your WordPress plugin readme.txt file exactly like it will appear on WordPress.org.
wpreadme.ir lets you paste or upload your readme.txt and see a faithful preview of the plugin directory layout before publishing.
Why I Built It
The WordPress plugin directory uses a specific readme.txt format. Formatting mistakes broken links, missing sections, or malformed headers, can make your plugin listing look unprofessional or cause it to be rejected during review. WPReadme Preview catches these issues before they go live.
Live Preview
Paste or type your readme.txt content and watch the preview update in real time. The tool parses the standard WordPress readme.txt format and renders a layout that matches the official plugin directory.
Supported readme.txt sections:
- Header, plugin name, contributors, tags, requirements, license, and short description
- Description with Markdown support
- Installation, setup instructions and requirements
- Frequently Asked Questions, parsed as expandable Q&A items
- Screenshots, captioned screenshot list
- Changelog, version history entries
Upload & Download
Upload an existing readme.txt file to start editing right away, then download the updated version after making changes.
Example Files
Load pre-built example readme.txt files to see how different plugins are formatted and to learn the expected structure.
Readme Validator
Auto-validates your readme.txt against WordPress.org requirements with a progress bar and categorized tips for Required, Recommended, and Optional checks.
- Required: Plugin Name, Contributors, Tags, Stable Tag, License, Short Description, Description, Changelog, File Size
- Recommended: Requires at least, Tested up to, Installation section
- Optional: Requires PHP, FAQ section, Screenshots, Donate link
Each failed check includes a tip with the exact line to add and a link to the relevant WordPress.org documentation.
Tech Notes
- Built with JavaScript and Astro for a fast, lightweight experience
- Follows the official WordPress readme.txt standard as documented at developer.wordpress.org
- Fully responsive, works on desktop and mobile
- Free to use with no registration required
