2017 © Pedro Peláez
 

library wp2md

CLI tool for converting WordPress Plugin readme.txt to Markdown

image

wpreadme2markdown/wp2md

CLI tool for converting WordPress Plugin readme.txt to Markdown

  • Sunday, December 17, 2017
  • by sunchaser
  • Repository
  • 2 Watchers
  • 3 Stars
  • 670 Installations
  • PHP
  • 8 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 10 Versions
  • 68 % Grown

The README.md

WP Readme to Markdown

Packagist Code Climate, (*1)

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown. The tool is built on the WP Readme to Markdown Library, (*2)

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

Add a composer dependency to your project:, (*3)

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

The binary will be vendor/bin/wp2md, (*4)

Download binary

You may install WP2MD binary globally, (*5)

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, (*6)

  • 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, (*7)

The Versions

17/12 2017

dev-master

9999999-dev

CLI tool for converting WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

24/11 2017

3.0.1

3.0.1.0

CLI tool for converting WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

06/08 2017

3.0.0

3.0.0.0

CLI tool for converting WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

12/08 2016

2.0.2

2.0.2.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

29/05 2016

2.0.1

2.0.1.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

28/05 2014

2.0.0

2.0.0.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

25/05 2014

1.1.1

1.1.1.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

18/05 2014

1.1.0

1.1.0.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

11/05 2014

1.0.1

1.0.1.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme

10/05 2014

1.0.0

1.0.0.0

Convert WordPress Plugin readme.txt to Markdown

  Sources   Download

MIT

The Requires

 

by Christian Archer
by Benjamin J. Balter

wordpress markdown converter readme