PHPackages fr3nch13/phpdoc-markdown - 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. fr3nch13/phpdoc-markdown AbandonedArchivedLibrary[Parsing & Serialization](/categories/parsing) fr3nch13/phpdoc-markdown ======================== phpDocumentor template that generates Markdown documentation. 1.0.6(6y ago)71.2k7[1 issues](https://github.com/fr3nch13/phpdoc-markdown/issues)MITTwig Since Oct 30Pushed 3y ago1 watchersCompare [ Source](https://github.com/fr3nch13/phpdoc-markdown)[ Packagist](https://packagist.org/packages/fr3nch13/phpdoc-markdown)[ Docs](https://dfir-bedlam.ocio.nih.gov/fr3nch13/phpdoc-markdown)[ RSS](/packages/fr3nch13-phpdoc-markdown/feed)WikiDiscussions master Synced 2w ago READMEChangelog (7)Dependencies (2)Versions (8)Used By (0) Archived. ========= [](#archived) I'm archiving this project, but I'll keep it up if anyone wants to fork it. The last time I tried ig with phpdoc was version 2.9.0, so I'm pretty sure it will no longer with with version 3.x phpDocumentor markdown template =============================== [](#phpdocumentor-markdown-template) [phpDocumentor template](http://www.phpdoc.org/docs/latest/getting-started/changing-the-look-and-feel.html) that generates Markdown documentation. This is basically a markdown version of phpDocumentor's Clean template. The main use-case for this template is to generate simple and nice looking usage documentation, that can then be published on GitHub/GitLab. For example, a small library can document it's public API in DocBlock comments, use this template to generate the Markdown documentation and then commit it to GitHub with the library to easily create a nice looking documentation for other developers to see. Installation ------------ [](#installation) Install with composer: ``` composer require fr3nch13/phpdoc-markdown ``` Usage ----- [](#usage) Run phpDocumentor and set template as `vendor/fr3nch13/phpdoc-markdown/data/templates/markdown`. This requires the usage of the `phpdoc.xml` file as phpDocumentor only generates html files, and they need to be changed to md files, and the links in the generated templates need to be modified. This is done using a php script in the bin/directory that uses the `phpdoc.xml` file to know where the generated templates are located. **Example using configuration file:** Add a file called `phpdoc.xml` with the following content to the root of your project and invoke the `phpdoc` command without arguments. Modify the configuration to suit your project. ``` My Project Documentation build docs src test/* ``` After you've created the phpdoc.xml, you can now run phpdoc without arguments, then run the php script to fix the generated files. ``` $ vendor/bin/phpdoc && php vendor/fr3nch13/phpdoc-markdown/bin/fixHtmltoMd.php ``` Or, you can add it to your composer.json scripts section, this is how I do it. ``` "scripts": { "phpdoc": [ "export COMPOSER_PROCESS_TIMEOUT=9000", "@phpdoc-run", "@phpdoc-fix" ], "phpdoc-run": "vendor/bin/phpdoc -v", "phpdoc-fix": "php vendor/fr3nch13/phpdoc-markdown/bin/fixHtmlToMd.php" } ``` Then run: ``` $ composer phpdoc ``` More information about [configuring phpDocumentor](http://www.phpdoc.org/docs/latest/references/configuration.html). [Packagist: fr3nch13/phpdoc-markdown](https://packagist.org/packages/fr3nch13/phpdoc-markdown) ### Health Score 32 — LowBetter than 69% of packages Maintenance17 Infrequent updates — may be unmaintained Popularity23 Limited adoption so far Community12 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 75% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~4 days Total 7 Last Release 2401d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/a8db156d8ccab278b11d1d79631bbeb9374b93193d5408fd05417cd3e51ba27f?d=identicon)[fr3nch13](/maintainers/fr3nch13) --- Top Contributors [![devcorrelator](https://avatars.githubusercontent.com/u/13592517?v=4)](https://github.com/devcorrelator "devcorrelator (9 commits)")[![fr3nch13](https://avatars.githubusercontent.com/u/7828?v=4)](https://github.com/fr3nch13 "fr3nch13 (3 commits)") --- Tags phpdocdocumentationphpDocumentormarkdown ### Embed Badge ![Health badge](/badges/fr3nch13-phpdoc-markdown/health.svg) ``` [![Health](https://phpackages.com/badges/fr3nch13-phpdoc-markdown/health.svg)](https://phpackages.com/packages/fr3nch13-phpdoc-markdown) ``` ### Alternatives [cvuorinen/phpdoc-markdown-public phpDocumentor template that generates Markdown documentation of the public API 3513.8k29](/packages/cvuorinen-phpdoc-markdown-public)[daux/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 825195.5k1](/packages/daux-dauxio)[nelson6e65/phpdoc-vuepress Template for generating your PHP API documentation in a pretty VuePress format. 234.6k2](/packages/nelson6e65-phpdoc-vuepress)[dudo1985/wpdocgen Documentation Generator for WordPress. 2330.5k](/packages/dudo1985-wpdocgen)[saggre/phpdocumentor-markdown Markdown template for phpDocumentor3 2293.1k41](/packages/saggre-phpdocumentor-markdown)[clean/phpdoc-md Parse PHP classes and writes documentation to markdown files 44136.1k44](/packages/clean-phpdoc-md) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)