wpreadme2markdown/wp2md

CLI tool for converting WordPress Plugin readme.txt to Markdown

4.1.2 2024-12-16 19:46 UTC

Requires

• php: ^7.2.5 || ^8.0
• composer-runtime-api: >= 2.0.0
• symfony/console: ^5 || ^6 || ^7
• wpreadme2markdown/wpreadme2markdown: ^4.1.0

Requires (Dev)

• ext-json: *
• indeyets/pake: ~1.99
• php5friends/polyfill-create_function: ^0.0.4
• secondtruth/phar-compiler: ~1.1
• squizlabs/php_codesniffer: *

MIT

• Benjamin J. Balter
• Christian Archer

• markdown
• wordpress
• converter
• readme

README

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown. The tool is built on the WP Readme to Markdown Library

Features

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

Usage

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

Installation

Composer (recommended)

Add a composer dependency to your project:

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

The binary will be vendor/bin/wp2md

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

# 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

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