Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varunsridharan/wp2github-md
WordPress README.txt To GitHub README.md Converter
https://github.com/varunsridharan/wp2github-md
markdown readme-md wordpress wordpress-development wordpress-plugin wordpress-plugins wordpress-readme wp-library wp-plugin
Last synced: 8 days ago
JSON representation
WordPress README.txt To GitHub README.md Converter
- Host: GitHub
- URL: https://github.com/varunsridharan/wp2github-md
- Owner: varunsridharan
- License: gpl-3.0
- Created: 2019-07-10T08:42:40.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-11T08:04:38.000Z (over 3 years ago)
- Last Synced: 2024-10-10T02:23:03.483Z (29 days ago)
- Topics: markdown, readme-md, wordpress, wordpress-development, wordpress-plugin, wordpress-plugins, wordpress-readme, wp-library, wp-plugin
- Language: PHP
- Homepage: https://packagist.org/packages/varunsridharan/wp2github-md
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WP2GithubMD Parser
WordPress Readme To Github Readme Converter
[![Latest Stable Version][latest-stable-version-img]][latest-stable-version-link]
[![Latest Unstable Version][latest-Unstable-version-img]][latest-Unstable-version-link]
[![Total Downloads][total-downloads-img]][total-downloads-link]
[![WP][wpcs-img]][wpcs-link]
[![License][license-img]][license-link]
[![composer.lock available][composerlock-img]][composerlock-link]
## Installation
The preferred way to install this extension is through [Composer][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][downloadzip]:
$ 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**
```json
{
"scripts" : {
"wp2github-md": "wp2github-md 'plugin-slug' 'readme.txt' 'readme.md' "
}
}
```
**Composer Run** : `composer wp2github-md`
### PHP
```php
## š Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
[Checkout CHANGELOG.md](https://github.com/varunsridharan/wp2github-md/blob/main/CHANGELOG.md)
## š¤ Contributing
If you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/wp2github-md/issues/).
## š License & Conduct
- [**GNU General Public License v3.0**](https://github.com/varunsridharan/wp2github-md/blob/main/LICENSE) Ā© [Varun Sridharan](website)
- [Code of Conduct](https://github.com/varunsridharan/.github/blob/main/CODE_OF_CONDUCT.md)
## š£ Feedback
- ā This repository if this project helped you! :wink:
- Create An [š§ Issue](https://github.com/varunsridharan/wp2github-md/issues/) if you need help / found a bug
## š° Sponsor
[I][twitter] fell in love with open-source in 2013 and there has been no looking back since! You can read more about me [here][website].
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**][buymeacoffee]
- āļøāļø How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]
- š° We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]
- š Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]
[paypal]: https://sva.onl/paypal
[buymeacoffee]: https://sva.onl/buymeacoffee
[twitter]: https://sva.onl/twitter/
[website]: https://sva.onl/website/
## Connect & Say š
- **Follow** me on [šØāš» Github][github] and stay updated on free and open-source software
- **Follow** me on [š¦ Twitter][twitter] to get updates on my latest open source projects
- **Message** me on [š Telegram][telegram]
- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!
[sofythelabrador]: https://www.instagram.com/sofythelabrador/
[github]: https://sva.onl/github/
[twitter]: https://sva.onl/twitter/
[telegram]: https://sva.onl/telegram/
---
Built With ā„ By Varun Sridharan
---
[composer]: http://getcomposer.org/download/
[downloadzip]:https://github.com/varunsridharan/wp2github-md/archive/master.zip
[latest-stable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/version
[latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/v/unstable
[total-downloads-img]: https://poser.pugx.org/varunsridharan/wp2github-md/downloads
[Latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/v/unstable
[wpcs-img]: https://img.shields.io/badge/WordPress-Standar-1abc9c.svg
[license-img]: https://poser.pugx.org/varunsridharan/wp2github-md/license
[composerlock-img]: https://poser.pugx.org/varunsridharan/wp2github-md/composerlock
[latest-stable-version-link]: https://packagist.org/packages/varunsridharan/wp2github-md
[latest-Unstable-version-link]: https://packagist.org/packages/varunsridharan/wp2github-md
[total-downloads-link]: https://packagist.org/packages/varunsridharan/wp2github-md
[Latest-Unstable-Version-link]: https://packagist.org/packages/varunsridharan/wp2github-md
[wpcs-link]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/
[license-link]: https://packagist.org/packages/varunsridharan/wp2github-md
[composerlock-link]: https://packagist.org/packages/varunsridharan/wp2github-md