wpreadme2markdown / wp2md
CLI tool for converting WordPress Plugin readme.txt to Markdown
Installs: 48 708
Dependents: 6
Suggesters: 0
Security: 0
Stars: 18
Watchers: 2
Forks: 4
Open Issues: 1
Requires
- php: ^7.2.5 || ^8.0
- composer-runtime-api: >= 2.0.0
- symfony/console: ^5 || ^6
- wpreadme2markdown/wpreadme2markdown: ^4.0.3
Requires (Dev)
- ext-json: *
- indeyets/pake: ~1.99
- secondtruth/phar-compiler: ~1.1
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
composerwith 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