Skip to main content
Help us improve Python packaging – donate today!

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 https://github.com/benbalter/WP-Readme-to-Github-Markdown

Requirements

Python 2.7

Installation

python setup.py 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)

Usage

See: wp2github -h

For example:

wp2github --source SOURCE.txt --target TARGET.md

Versioning

This project implements the Semantic Versioning guidelines.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

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 http://semver.org.

License

Copyright (c) 2013 Sergey Storchay, http://r8.com.ua

Licensed under MIT: https://raw.github.com/r8/wp2github.py/master/LICENSE.txt

Changelog

1.1.3

  • Add line break between screenshot image and description

1.1.0

  • Convert screenshots section

Release history Release notifications

This version
History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

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
wp2github-1.1.3.zip (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 CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page