Skip to main content

Convert WordPress plugin readme file to GitHub Flavored Markdown

Project description

Command-line tool that converts WordPress-style Readme file to GitHub Markdown Readme.

Inspired by


Python 2.7


python install

Also you may use pip:

pip install wp2github

This will create a wp2github script in /usr/local/bin (linux) or c:2.7(windows)


See: wp2github -h

For example:

wp2github --source SOURCE.txt --target


This project implements the Semantic Versioning guidelines.

Releases will be numbered with the following format:


And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit


Copyright (c) 2013 Sergey Storchay,

Licensed under MIT:



  • Add line break between screenshot image and description


  • Convert screenshots section

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date (10.0 kB) Copy SHA256 hash SHA256 Source None Jul 20, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page