wpreadme2markdown/wpreadme2markdown

This package is abandoned and no longer maintained. No replacement package was suggested.

Convert WordPress Plugin readme.txt to Markdown

Package info

github.com/wpreadme2markdown/wp-readme-to-markdown

pkg:composer/wpreadme2markdown/wpreadme2markdown

Statistics

Installs: 66 463

Dependents: 4

Suggesters: 0

Stars: 94

Open Issues: 1

5.0.0 2026-06-12 17:16 UTC

Requires

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 4c8ccdbf2e51f6e0f7aae663c7114f01ac9fb4b0

  • Benjamin J. Balter
  • Christian Archer <sunchaser.woop@sunchaser.info>

markdownwordpressconverterreadme

This package is auto-updated.

Last update: 2026-06-12 17:25:12 UTC

README

👁 Packagist

The project is retired, my main reasons are:

  • I no longer use WordPress and develop plugins for it
  • I now agree with the idea that GitHub's readme and WordPress readme serve different purpose and should therefore be different
  • I see an effort from WordPress to prevent some features of this tool from working (screenshot detection)

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