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 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

Project details


Download files

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

Source Distribution

wp2github-1.1.3.zip (10.0 kB view details)

Uploaded Source

File details

Details for the file wp2github-1.1.3.zip.

File metadata

  • Download URL: wp2github-1.1.3.zip
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wp2github-1.1.3.zip
Algorithm Hash digest
SHA256 8869342e8ae16ae9eac37e848131a111ec9ed92911f7994b8b94473ff0c20936
MD5 0845da04be2c51ef1858044147e125b7
BLAKE2b-256 a45674d807c605753343ed1d01d15e5dc9261d0490eaa506eeeefd94c97e6c10

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page