README

WordPress Readme To Github Readme Converter

Installation

The preferred way to install this extension is through Composer.

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:

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

Usage

Command Line

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

Composer

Composer.json

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

Composer Run : composer wp2github-md

PHP

<?php
require_once __DIR__.'/vendor/autoload.php';

$markdown = \WP2Github_MD\Converter::convert(file_get_contents(__DIR__.'/readme.txt'),'your-plugin-slug');
file_put_contents(__DIR__.'/readme.md',$markdown);

Thanks To : https://github.com/wpreadme2markdown/wp-readme-to-markdown for creating this aweosme library i have created this to make an improved version.

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

📣 Feedback

⭐ This repository if this project helped you! 😉
Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

Follow me on 👨‍💻 Github and stay updated on free and open-source software
Follow me on 🐦 Twitter to get updates on my latest open source projects
Message me on 📠 Telegram
Follow my pet on Instagram for some dog-tastic updates!

Built With ♥ By Varun Sridharan

varunsridharan / wp2github-md

Maintainers

Details