wpreadme2markdown/wpreadme2markdown

Convert WordPress Plugin readme.txt to Markdown

4.1.1 2024-12-16 19:44 UTC

Requires

• php: ^7.2.5 || ^8.0
• guzzlehttp/guzzle: ^7.3

Requires (Dev)

• squizlabs/php_codesniffer: *

MIT

• Benjamin J. Balter
• Christian Archer

• markdown
• wordpress
• converter
• readme

README

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