PHPackages                             dcramble/phpdoc-md - 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 &amp; Serialization](/categories/parsing)
4. /
5. dcramble/phpdoc-md

ActiveLibrary[Parsing &amp; Serialization](/categories/parsing)

dcramble/phpdoc-md
==================

PHP documentation generator, with markdown output

v0.1.1(11y ago)02005MITPHPPHP &gt;=5.3.1

Since Nov 2Pushed 11y ago1 watchersCompare

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

READMEChangelog (1)Dependencies (2)Versions (10)Used By (5)

PHPDocumentor MarkDown export
=============================

[](#phpdocumentor-markdown-export)

This script will generate markdown (.md) API documentation files from a PHPDocumentor XML output file.

It only documents classes and interfaces.

This project was originally developed by [Evert Pot](https://twitter.com/evertp). See his [repo](https://github.com/evert/phpdoc-md) for more details.

Take a look at some [Example Markdown API Docs](https://github.com/MESD/SettingsBundle/blob/master/Resources/doc/api/ApiIndex.md).

Installation
------------

[](#installation)

This project assumes you have composer installed.

```
$ composer require dcramble/phpdoc-md "~0.1"
```

Usage
-----

[](#usage)

First ensure that phpdocumentor 2 is installed somewhere, after, you must generate a file called `structure.xml`.

The easiest is to create a temporary directory, for example named `docs/` as phpDocumentor2 creates a lot of 'cache' directories.

```
# phpdoc command
mkdir docs
cd docs
phpdoc  -d [project path] -t . --template="xml"
rm -r phpdoc-cache-*

# Next, run phpdocmd:
phpdocmd structure.xml [outputdir]

```

Options
-------

[](#options)

```
--lt [template]
    This specifies the 'template' for links we're generating. By default
    this is "%c.md".

--namespaced-names
    This specifies the fully qualified classes, with namespaces, should
    be printed.

```

This should generate all the .md files.

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 67.4% 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 ~91 days

Recently: every ~180 days

Total

9

Last Release

4218d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/913a7e89df67a38fbf087f84ff3a5b4bf4296f4dcab99eaf6c34f27818e989f3?d=identicon)[dcramble](/maintainers/dcramble)

---

Top Contributors

[![evert](https://avatars.githubusercontent.com/u/178960?v=4)](https://github.com/evert "evert (31 commits)")[![dcramble](https://avatars.githubusercontent.com/u/2166002?v=4)](https://github.com/dcramble "dcramble (9 commits)")[![gkcgautam](https://avatars.githubusercontent.com/u/1042921?v=4)](https://github.com/gkcgautam "gkcgautam (5 commits)")[![jelmersnoeck](https://avatars.githubusercontent.com/u/815655?v=4)](https://github.com/jelmersnoeck "jelmersnoeck (1 commits)")

---

Tags

phpphpdocmarkdown

### Embed Badge

![Health badge](/badges/dcramble-phpdoc-md/health.svg)

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

###  Alternatives

[evert/phpdoc-md

PHP documentation generator, with markdown output

169170.9k92](/packages/evert-phpdoc-md)[nelson6e65/phpdoc-vuepress

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

224.5k2](/packages/nelson6e65-phpdoc-vuepress)[dudo1985/wpdocgen

Documentation Generator for WordPress.

2327.6k](/packages/dudo1985-wpdocgen)

PHPackages © 2026

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