On this page:
This is the home page for the Plugin-readme Parser WordPress plugin. It is not yet available from the WordPress plugin directory, but I hope it soon will be.
Plugin-readme Parser aims to replace the WP Readme Parser/Plugin README Parser plugin by David Artiss, which is now broken and, as far as I’m aware, no longer maintained.
The code
Development
The latest code is available on GitHub:
The GitHub repository does not necessarily contain the latest release because it contains development code; it should not be considered as safe to use.
Latest changes in the GIT repository
- Fixes typo in variable name.
- Moves most of the functions in functions.php to Generate_Output.
- Merge branch 'phpdoc-support'
- Adds further documentation.
- Comments out lots of php_log() calls.
- Improves documentation; uses phpdoc spec.
- Replaces code with simple return statement.
- Renames return variable.
- Improves display of WP_Error objects.
- Adds display of previous exception, if any.
Release
The plug-in has not yet been released, so it is not yet available to install from the WordPress plugin directory.
Demonstration
You can see a demonstration of the plugin on this website for the readme for the Blipper Widget WordPress plugin.
Usage notes
This plugin uses WP shortcodes. If you’re not familiar with using shortcodes in WordPress, you can read the official documentation for WordPress Shortcode blocks or a beginner’s guide to working with shortcodes in WordPress.
Readme file
The readme file will be available once the plugin is available from the WordPress plugin directory.
The readme file has more details about the plugin.
Development notes
Plugin-readme Parser, a WordPress plugin
I update an existing WordPress plugin to parse WordPress plugin readme files and display the contents as HTML.
Plugin-readme Parser
Details of an updated WordPress plugin to parse WordPress plugin readme files and display the contents as HTML.
