WordPress.org

Plugin Directory

Plugin README Parser

Plugin README Parser will display a WordPress plugin's README file in XHTML format, for embedding on a post or page.

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
  • 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.

Requires: 2.0 or higher
Compatible up to: 4.3
Last Updated: 2015-8-26
Active Installs: 300+

Ratings

5 out of 5 stars

Support

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
100,1,1
100,1,1
0,1,0
100,1,1 100,1,1
100,1,1
0,1,0
100,1,1