PHPackages                             wpreadme2markdown/wp2md - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. wpreadme2markdown/wp2md

AbandonedLibrary[Parsing &amp; Serialization](/categories/parsing)

wpreadme2markdown/wp2md
=======================

CLI tool for converting WordPress Plugin readme.txt to Markdown

4.3.1(3d ago)1963.3k↑35.8%44MITPHPPHP ^8.1CI failing

Since Aug 6Pushed 3d ago1 watchersCompare

[ Source](https://github.com/wpreadme2markdown/wp2md)[ Packagist](https://packagist.org/packages/wpreadme2markdown/wp2md)[ RSS](/packages/wpreadme2markdown-wp2md/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (14)Versions (15)Used By (4)

WP Readme to Markdown
=====================

[](#wp-readme-to-markdown)

[![Packagist](https://camo.githubusercontent.com/d2735dd1c3541477953d88d1aab64019721ede65f5323839c15a3c8385563576/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7770726561646d65326d61726b646f776e2f7770326d642e7376673f6d61784167653d32353932303030)](https://packagist.org/packages/wpreadme2markdown/wp2md)

> 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. The tool is built on the [WP Readme to Markdown Library](https://github.com/wpreadme2markdown/wp-readme-to-markdown)

Features
--------

[](#features)

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

Usage
-----

[](#usage)

```
# with files as params
wp2md -i readme.txt -o README.md
# or with unix pipes
wp2md < readme.txt > README.md

```

Installation
------------

[](#installation)

### Composer (recommended)

[](#composer-recommended)

Add a composer dependency to your project:

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

```

The binary will be `vendor/bin/wp2md`

### Download binary

[](#download-binary)

You may install WP2MD binary globally

```
sudo wget https://github.com/wpreadme2markdown/wp2md/releases/latest/download/wp2md.phar -O /usr/local/bin/wp2md
sudo chmod a+x /usr/local/bin/wp2md

```

PHAR compilation
----------------

[](#phar-compilation)

```
# install dependencies
composer install
# run pake build script
composer pake phar

```

Executable PHAR archive will be created as `build/wp2md.phar`

- This assumes composer is installed as a package in your operating system. If not, replace `composer` with php command and your composer.phar location (i.e. `php ../phars/composer.phar`)

Web Version
-----------

[](#web-version)

Visit [this GitHub page](https://github.com/wpreadme2markdown/web) for the web version and a link to its running instance

###  Health Score

64

—

FairBetter than 99% of packages

Maintenance99

Actively maintained with recent releases

Popularity39

Limited adoption so far

Community24

Small or concentrated contributor base

Maturity79

Established project with proven stability

 Bus Factor1

Top contributor holds 59.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~250 days

Recently: every ~142 days

Total

14

Last Release

3d ago

Major Versions

3.1.0 → 4.0.02021-07-19

PHP version history (3 changes)3.0.0PHP &gt;= 5.5.9

4.0.0PHP ^7.2.5 || ^8.0

4.2.0PHP ^8.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/186433?v=4)[sunchaser](/maintainers/sunchaser)[@sunchaser](https://github.com/sunchaser)

---

Top Contributors

[![sunchaserinfo](https://avatars.githubusercontent.com/u/963483?v=4)](https://github.com/sunchaserinfo "sunchaserinfo (56 commits)")[![benbalter](https://avatars.githubusercontent.com/u/282759?v=4)](https://github.com/benbalter "benbalter (18 commits)")[![nextgenthemes](https://avatars.githubusercontent.com/u/1780826?v=4)](https://github.com/nextgenthemes "nextgenthemes (5 commits)")[![webaware](https://avatars.githubusercontent.com/u/1294614?v=4)](https://github.com/webaware "webaware (3 commits)")[![inderpreet99](https://avatars.githubusercontent.com/u/430386?v=4)](https://github.com/inderpreet99 "inderpreet99 (3 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![codebykat](https://avatars.githubusercontent.com/u/52152?v=4)](https://github.com/codebykat "codebykat (2 commits)")[![zackkatz](https://avatars.githubusercontent.com/u/870979?v=4)](https://github.com/zackkatz "zackkatz (1 commits)")[![hypernumbers](https://avatars.githubusercontent.com/u/214775?v=4)](https://github.com/hypernumbers "hypernumbers (1 commits)")[![jamesgol](https://avatars.githubusercontent.com/u/6788517?v=4)](https://github.com/jamesgol "jamesgol (1 commits)")[![LC43](https://avatars.githubusercontent.com/u/48201?v=4)](https://github.com/LC43 "LC43 (1 commits)")[![szepeviktor](https://avatars.githubusercontent.com/u/952007?v=4)](https://github.com/szepeviktor "szepeviktor (1 commits)")

---

Tags

wordpressconvertermarkdownreadme

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/wpreadme2markdown-wp2md/health.svg)

```
[![Health](https://phpackages.com/badges/wpreadme2markdown-wp2md/health.svg)](https://phpackages.com/packages/wpreadme2markdown-wp2md)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.8k543.8M20.1k](/packages/laravel-framework)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

21866.0M1.7k](/packages/drupal-core)[flow-php/flow

PHP ETL - Extract Transform Load - Data processing framework

85036.3k](/packages/flow-php-flow)[kimai/kimai

Kimai - Time Tracking

4.8k9.0k1](/packages/kimai-kimai)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M574](/packages/shopware-core)[open-dxp/opendxp

Content &amp; Product Management Framework (CMS/PIM)

9421.6k61](/packages/open-dxp-opendxp)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
