Convert WordPress Plugin Readme Files to GitHub Flavored Markdown
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
LICENSE.md
Pakefile.php
README.md
composer.json

README.md

WP Readme to Markdown

Packagist Code Climate

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown

Features

  • Converts headings
  • Formats contributors, donate link, etc.
  • Inserts screenshots

Usage

$markdown = \WPReadme2Markdown\Converter::convert($readme);

Installation

Composer (recommended)

Add a composer dependency to your project:

"require-dev": {
    "wpreadme2markdown/wpreadme2markdown": "*"
}

CLI Version

Visit this GitHub page for the CLI version

Web Version

Visit this GitHub page for the web version and a link to its running instance