{"id":16055893,"url":"https://github.com/varunsridharan/wp2github-md","last_synced_at":"2025-06-20T17:36:14.453Z","repository":{"id":57077007,"uuid":"196167568","full_name":"varunsridharan/wp2github-md","owner":"varunsridharan","description":"WordPress README.txt To GitHub README.md Converter","archived":false,"fork":false,"pushed_at":"2021-04-11T08:04:38.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-05T08:14:14.875Z","etag":null,"topics":["markdown","readme-md","wordpress","wordpress-development","wordpress-plugin","wordpress-plugins","wordpress-readme","wp-library","wp-plugin"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/varunsridharan/wp2github-md","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varunsridharan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-10T08:42:40.000Z","updated_at":"2021-04-11T08:05:57.000Z","dependencies_parsed_at":"2022-08-24T12:51:03.754Z","dependency_job_id":null,"html_url":"https://github.com/varunsridharan/wp2github-md","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"varunsridharan/git-template","purl":"pkg:github/varunsridharan/wp2github-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fwp2github-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fwp2github-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fwp2github-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fwp2github-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varunsridharan","download_url":"https://codeload.github.com/varunsridharan/wp2github-md/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varunsridharan%2Fwp2github-md/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260988585,"owners_count":23093524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","readme-md","wordpress","wordpress-development","wordpress-plugin","wordpress-plugins","wordpress-readme","wp-library","wp-plugin"],"created_at":"2024-10-09T02:23:00.132Z","updated_at":"2025-06-20T17:36:09.398Z","avatar_url":"https://github.com/varunsridharan.png","language":"PHP","readme":"# WP2GithubMD Parser\nWordPress Readme To Github Readme Converter\n\n[![Latest Stable Version][latest-stable-version-img]][latest-stable-version-link]\n[![Latest Unstable Version][latest-Unstable-version-img]][latest-Unstable-version-link]\n[![Total Downloads][total-downloads-img]][total-downloads-link]\n[![WP][wpcs-img]][wpcs-link]\n[![License][license-img]][license-link]\n[![composer.lock available][composerlock-img]][composerlock-link]\n\n## Installation\nThe preferred way to install this extension is through [Composer][composer].\n\nTo install **WP2GithubMd library**, simply:\n\n    $ composer require varunsridharan/wp2github-md\n\nThe previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:\n\n    $ composer require varunsridharan/wp2github-md --prefer-source\n\nYou can also **clone the complete repository** with Git:\n\n    $ git clone https://github.com/varunsridharan/wp2github-md.git\n\nOr **install it manually**:\n\n[Download WP2GithubMd.zip][downloadzip]:\n\n    $ wget https://github.com/varunsridharan/wp2github-md/archive/master.zip\n\n## Usage\n### Command Line\n```\nwp2github-md \"your-plugin-slug\" \"current-path/readme.txt\" \"save-markdown/readme.md\"\n```\n### Composer\n**Composer.json**\n```json\n{\n  \"scripts\" : {\n    \"wp2github-md\": \"wp2github-md 'plugin-slug' 'readme.txt' 'readme.md' \"\n  }\n}\n```\n\n**Composer Run** : `composer wp2github-md`\n\n### PHP\n```php\n\u003c?php\nrequire_once __DIR__.'/vendor/autoload.php';\n\n$markdown = \\WP2Github_MD\\Converter::convert(file_get_contents(__DIR__.'/readme.txt'),'your-plugin-slug');\nfile_put_contents(__DIR__.'/readme.md',$markdown);\n```\n\n---\n\nThanks To : https://github.com/wpreadme2markdown/wp-readme-to-markdown for creating this aweosme library i have created this to make an improved version.\n\n\n---\n\n\u003c!-- START common-footer.mustache  --\u003e\n## 📝 Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n[Checkout CHANGELOG.md](https://github.com/varunsridharan/wp2github-md/blob/main/CHANGELOG.md)\n\n\n## 🤝 Contributing\nIf you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/wp2github-md/issues/).\n\n\n## 📜  License \u0026 Conduct\n- [**GNU General Public License v3.0**](https://github.com/varunsridharan/wp2github-md/blob/main/LICENSE) © [Varun Sridharan](website)\n- [Code of Conduct](https://github.com/varunsridharan/.github/blob/main/CODE_OF_CONDUCT.md)\n\n\n## 📣 Feedback\n- ⭐ This repository if this project helped you! :wink:\n- Create An [🔧 Issue](https://github.com/varunsridharan/wp2github-md/issues/) if you need help / found a bug\n\n\n## 💰 Sponsor\n[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].\nIf 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.\n\n- ☕ How about we get to know each other over coffee? Buy me a cup for just [**$9.99**][buymeacoffee]\n- ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]\n- 🔰         We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]\n- 🚀         Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]\n\n\u003c!-- Personl Links --\u003e\n[paypal]: https://sva.onl/paypal\n[buymeacoffee]: https://sva.onl/buymeacoffee\n[twitter]: https://sva.onl/twitter/\n[website]: https://sva.onl/website/\n\n\n## Connect \u0026 Say 👋\n- **Follow** me on [👨‍💻 Github][github] and stay updated on free and open-source software\n- **Follow** me on [🐦 Twitter][twitter] to get updates on my latest open source projects\n- **Message** me on [📠 Telegram][telegram]\n- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!\n\n\u003c!-- Personl Links --\u003e\n[sofythelabrador]: https://www.instagram.com/sofythelabrador/\n[github]: https://sva.onl/github/\n[twitter]: https://sva.onl/twitter/\n[telegram]: https://sva.onl/telegram/\n\n\n---\n\n\u003cp align=\"center\"\u003e\n\u003ci\u003eBuilt With ♥ By \u003ca href=\"https://sva.onl/twitter\"  target=\"_blank\" rel=\"noopener noreferrer\"\u003eVarun Sridharan\u003c/a\u003e \u003ca href=\"https://en.wikipedia.org/wiki/India\"\u003e\n   \u003cimg src=\"https://cdn.svarun.dev/flag-india.jpg\" width=\"20px\"/\u003e\u003c/a\u003e \u003c/i\u003e \u003cbr/\u003e\u003cbr/\u003e\n   \u003cimg src=\"https://cdn.svarun.dev/codeispoetry.png\"/\u003e\n\u003c/p\u003e\n\n---\n\n\n\u003c!-- END common-footer.mustache  --\u003e\n\n\n[composer]: http://getcomposer.org/download/\n[downloadzip]:https://github.com/varunsridharan/wp2github-md/archive/master.zip\n\n[latest-stable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/version\n[latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/v/unstable\n[total-downloads-img]: https://poser.pugx.org/varunsridharan/wp2github-md/downloads\n[Latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp2github-md/v/unstable\n[wpcs-img]: https://img.shields.io/badge/WordPress-Standar-1abc9c.svg\n[license-img]: https://poser.pugx.org/varunsridharan/wp2github-md/license\n[composerlock-img]: https://poser.pugx.org/varunsridharan/wp2github-md/composerlock\n\n[latest-stable-version-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n[latest-Unstable-version-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n[total-downloads-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n[Latest-Unstable-Version-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n[wpcs-link]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/\n[license-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n[composerlock-link]: https://packagist.org/packages/varunsridharan/wp2github-md\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Fwp2github-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarunsridharan%2Fwp2github-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarunsridharan%2Fwp2github-md/lists"}