Skip to main content

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

Metadata

Release files for wp2github 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wp2github 1.1.3
File Size Uploaded
wp2github-1.1.3.zip 10.0 kB Details

Release files / wp2github-1.1.3.zip

Download URL wp2github-1.1.3.zip
Size 10.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8869342e8ae16ae9eac37e848131a111ec9ed92911f7994b8b94473ff0c20936
BLAKE2b-256 checksum
How to use checksums
a45674d807c605753343ed1d01d15e5dc9261d0490eaa506eeeefd94c97e6c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.1.3 This release

1 release file

1.1.2

1 release file

1.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page