/wp-readme-to-markdown

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown

Primary LanguagePHPMIT LicenseMIT

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

Add a composer dependency to your project:

composer require wpreadme2markdown/wpreadme2markdown --dev

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