WordPress.org

WordPress README files are formatted using a version of the Markdown language. This plugin can be used to convert these to XHTML and display on a post or page of your site.

It's ideal for plugin developers who wish to add instructions to their own site without having to duplicate effort.

Features include...

• XHTML compliant output
• Convert your markdown README to XHTML and display in any post or page
• Use shortcodes or a direct PHP function call
• Responsive output of screenshots
• Output is cached for maximum performance
• Links automatically added to author and tag information
• Download links added
• Ability to specify which sections of the readme to exclude
• Can also omit specific lines of text
• Extra shortcodes available to display plugin banners and to return specific plugin data (download link, version number, etc)
• Google Translation suppressed on code output
• Fully internationalized ready for translations. If you would like to add a translation to his plugin then please contact me
• And many more!

To use, simply add the [readme] shortcode to any post or page. An example of use would be...

[readme]WP README Parser[/readme]

This would fetch and display the README for this plugin. You can also specify a filename instead.

The first heading, which is the name of the plugin, will be automatically suppressed as it is assumed that you have already added this to your post/page or are using it as the title.

This should get you started but for more information and advanced options please read the "Other Notes" tab.

For help with this plugin, or simply to comment or get in touch, please read the appropriate section in "Other Notes" for details. This plugin, and all support, is supplied for free, but donations are always welcome.