# Plugin README Parser

<img src="https://ps.w.org/wp-readme-parser/assets/icon.svg" width=128px align="left" style="padding-right: 20px">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...

* 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

Plugin README Parser uses [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/ "PHP Markdown Extra") by Michel Fortin.

Iconography is courtesy of [Flatart](https://www.freepik.com/flatart) ♥️

### Reviews & Mentions

[WPCandy](http://wpcandy.com/reports/wp-readme-parser-plugin-converts-plugins-readme-into-blog-ready-xhtml?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+wpcandy+%28WPCandy+-+The+Best+of+WordPress%29 "WPCandy") - WP README Parser Plugin converts Plugin's readme into blog-ready XHTML

<p align="right"><a href="https://wordpress.org/plugins/wp-readme-parser/"><img src="https://img.shields.io/wordpress/plugin/dt/wp-readme-parser?label=wp.org%20downloads&style=for-the-badge">&nbsp;<img src="https://img.shields.io/wordpress/plugin/stars/wp-readme-parser?color=orange&style=for-the-badge"></a></p>