PHPackages                             ramynasr/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. [Templating & Views](/categories/templating)
4. /
5. ramynasr/phpdoc-markdown

ActiveLibrary[Templating & Views](/categories/templating)

ramynasr/phpdoc-markdown
========================

phpDocumentor v3 template that generates Markdown documentation for Github.

1.0.1(3y ago)0132MITTwig

Since Jan 11Pushed 3y agoCompare

[ Source](https://github.com/ramynasr/phpdoc-markdown)[ Packagist](https://packagist.org/packages/ramynasr/phpdoc-markdown)[ Docs](https://github.com/ramynasr/phpdoc-markdown)[ RSS](/packages/ramynasr-phpdoc-markdown/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (3)Used By (0)

phpDocumentor v3 markdown template
==================================

[](#phpdocumentor-v3-markdown-template)

[phpDocumentor v3 template](https://docs.phpdoc.org/3.0/guide/features/theming/index.html) that generates Markdown documentation.

This is a heavily modified version of a [phpDocumentor v2 markdown template](https://github.com/fr3nch13/phpdoc-markdown).

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 ramynasr/phpdoc-markdown
```

Usage
-----

[](#usage)

Run phpDocumentor and set template as `vendor/ramynasr/phpdoc-markdown/data/templates/markdown`.

### Example using configuration file:

[](#example-using-configuration-file)

Add a file called `phpdoc.xml` (or `phpdoc.dist.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. You can read more about [phpDocumentor v3 configuration here](https://docs.phpdoc.org/3.0/guide/references/configuration.html).

```

        docs
        .phpdoc/cache

```

After you've created the configuration file, you can now run phpdoc without arguments, then run the php script to fix the generated files.

```
./vendor/bin/phpdoc && php ./vendor/ramynasr/phpdoc-markdown/bin/html-to-md.php --dir="docs"
```

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/ramynasr/phpdoc-markdown/bin/html-to-md.php"
}
```

Then run:

```
composer phpdoc
```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 64.3% 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 ~5 days

Total

2

Last Release

1216d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4364bbb7115ef915953aa4e04c07e1bc295a42751d8813779feb550eaa337879?d=identicon)[ramynasr](/maintainers/ramynasr)

---

Top Contributors

[![devcorrelator](https://avatars.githubusercontent.com/u/13592517?v=4)](https://github.com/devcorrelator "devcorrelator (9 commits)")[![ramynasr](https://avatars.githubusercontent.com/u/1080253?v=4)](https://github.com/ramynasr "ramynasr (3 commits)")[![fr3nch13](https://avatars.githubusercontent.com/u/7828?v=4)](https://github.com/fr3nch13 "fr3nch13 (2 commits)")

---

Tags

markdownpackagistphpphpdocumentortemplatetwigphpdocdocumentationphpDocumentormarkdowntemplategithub

### Embed Badge

![Health badge](/badges/ramynasr-phpdoc-markdown/health.svg)

```
[![Health](https://phpackages.com/badges/ramynasr-phpdoc-markdown/health.svg)](https://phpackages.com/packages/ramynasr-phpdoc-markdown)
```

###  Alternatives

[saggre/phpdocumentor-markdown

Markdown template for phpDocumentor3

2079.5k30](/packages/saggre-phpdocumentor-markdown)[cvuorinen/phpdoc-markdown-public

phpDocumentor template that generates Markdown documentation of the public API

3613.8k16](/packages/cvuorinen-phpdoc-markdown-public)[nelson6e65/phpdoc-vuepress

Template for generating your PHP API documentation in a pretty VuePress format.

224.5k2](/packages/nelson6e65-phpdoc-vuepress)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)