wpreadme2markdown/wpreadme2markdown

Convert WordPress Plugin readme.txt to Markdown

Installs: 41

Dependents: 1

Stars: 56

Watchers: 6

Forks: 14

Open Issues: 1

Language: PHP

2.0.0 2014-05-28 21:28 UTC

README

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown

Features

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

Usage

CLI:

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

PHP:

$markdown = \WPReadme2Markdown\Converter::convert($readme);

Installation

Composer (recommended)

Add a composer dependency to your project:

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

The binary will be vendor/bin/wp2md

Download binary

You may install WP2MD binary globally

sudo wget http://code.sunchaser.info/wp2md/downloads/wp2md.phar -O /usr/local/bin/wp2md
sudo chmod a+x /usr/local/bin/wp2md

PHAR compilation

# install composer
curl -sS https://getcomposer.org/installer | php
# install dependencies
php composer.phar install
# run pake build script
vendor/bin/pake phar

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

Online

Try the online version on wpreadme2markdown.com