PHPackages                             varunsridharan/wp2github-md - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. varunsridharan/wp2github-md

ActiveLibrary[Parsing & Serialization](/categories/parsing)

varunsridharan/wp2github-md
===========================

Lightweight Application To Convert WordPress Readme Into Github Markdown

1.4(6y ago)0249GPL-3.0-or-laterPHP

Since Jul 10Pushed 5y agoCompare

[ Source](https://github.com/varunsridharan/wp2github-md)[ Packagist](https://packagist.org/packages/varunsridharan/wp2github-md)[ Docs](https://github.com/varunsridharan/wp2github-md)[ RSS](/packages/varunsridharan-wp2github-md/feed)WikiDiscussions main Synced 6d ago

READMEChangelog (5)DependenciesVersions (6)Used By (0)

WP2GithubMD Parser
==================

[](#wp2githubmd-parser)

WordPress Readme To Github Readme Converter

[![Latest Stable Version](https://camo.githubusercontent.com/7a177bfca76cc19d7dddfc1bb8a881be1dcb83714d24f376af5ce1931b977593/68747470733a2f2f706f7365722e707567782e6f72672f766172756e73726964686172616e2f7770326769746875622d6d642f76657273696f6e)](https://packagist.org/packages/varunsridharan/wp2github-md)[![Latest Unstable Version](https://camo.githubusercontent.com/51d830762d1e51f09fdddb290fce83e333de503c8c6191ffe0df75bfa38f8816/68747470733a2f2f706f7365722e707567782e6f72672f766172756e73726964686172616e2f7770326769746875622d6d642f762f756e737461626c65)](https://packagist.org/packages/varunsridharan/wp2github-md)[![Total Downloads](https://camo.githubusercontent.com/96a93616921c9bb4a25588489634685bb53b93c725a1d20205ce7701295b052e/68747470733a2f2f706f7365722e707567782e6f72672f766172756e73726964686172616e2f7770326769746875622d6d642f646f776e6c6f616473)](https://packagist.org/packages/varunsridharan/wp2github-md)[![WP](https://camo.githubusercontent.com/ffba221a69a414072e7c2cb0bc46e849eddee342fbc151dd967cea940155c2b8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f576f726450726573732d5374616e6461722d3161626339632e737667)](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/)[![License](https://camo.githubusercontent.com/2aa3cbbc2ff0db9a8f9621192064334e73a8e3fbba1f2422518b13b6679a88ab/68747470733a2f2f706f7365722e707567782e6f72672f766172756e73726964686172616e2f7770326769746875622d6d642f6c6963656e7365)](https://packagist.org/packages/varunsridharan/wp2github-md)[![composer.lock available](https://camo.githubusercontent.com/b0a12c45d9cf56d348e23bdc314b84e33b1a7492bbeb33c21b6f11b24bd8e19f/68747470733a2f2f706f7365722e707567782e6f72672f766172756e73726964686172616e2f7770326769746875622d6d642f636f6d706f7365726c6f636b)](https://packagist.org/packages/varunsridharan/wp2github-md)

Installation
------------

[](#installation)

The preferred way to install this extension is through [Composer](http://getcomposer.org/download/).

To install **WP2GithubMd library**, simply:

```
$ composer require varunsridharan/wp2github-md

```

The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:

```
$ composer require varunsridharan/wp2github-md --prefer-source

```

You can also **clone the complete repository** with Git:

```
$ git clone https://github.com/varunsridharan/wp2github-md.git

```

Or **install it manually**:

[Download WP2GithubMd.zip](https://github.com/varunsridharan/wp2github-md/archive/master.zip):

```
$ wget https://github.com/varunsridharan/wp2github-md/archive/master.zip

```

Usage
-----

[](#usage)

### Command Line

[](#command-line)

```
wp2github-md "your-plugin-slug" "current-path/readme.txt" "save-markdown/readme.md"

```

### Composer

[](#composer)

**Composer.json**

```
{
  "scripts" : {
    "wp2github-md": "wp2github-md 'plugin-slug' 'readme.txt' 'readme.md' "
  }
}
```

**Composer Run** : `composer wp2github-md`

### PHP

[](#php)

```