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

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

gianiaz/phpdoc-md
=================

PHP documentation generator, with markdown output

0.3.0(8y ago)03.1k↓100%MITPHPPHP >=7.0.0

Since Nov 2Pushed 8y ago1 watchersCompare

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

READMEChangelogDependencies (3)Versions (12)Used By (0)

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

[](#phpdocumentor-markdown-export)

This is a script that can generate markdown (.md) files for your API documentation.

It is tailored for projects using PSR-0, PSR-1, PSR-2, PSR-4 and namespaces. The project was primarily developed for [sabre/dav](https://sabre.io/), but it should work for other codebases as well.

It only documents classes and interfaces.

The code is ugly, it was intended as a one-off, and I was in a hurry.. so the codebase may not be up to your standards. (it certainly isn't up to mine).

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

[](#installation)

This project assumes you have composer installed. Simply add:

```
"require-dev" : {

    "gianiaz/phpdoc-md" : "~0.3.0"

}

```

To your composer.json, and then you can simply install with:

```
composer install

```

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/`.

```
# phpdoc command
phpdoc  -d [project path] -t docs/ --template="xml"

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

```

Options
-------

[](#options)

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

--index [filename]
    This specifies the 'filename' for API Index markdown file we're generating.
    By default this is "ApiIndex.md".

```

This should generate all the .md files. I'm excited to hear your feedback.

Cheers, [Evert](https://twitter.com/evertp)[gianiaz](https://twitter.com/gianiaz)

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90.2% 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 ~192 days

Recently: every ~455 days

Total

11

Last Release

3021d ago

PHP version history (2 changes)0.0.1PHP >=5.3.1

0.3.0PHP >=7.0.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/f25292a3467a01d04c04693dbdb656835c7635310ee1f99996dc2da202f43f0d?d=identicon)[gianiaz](/maintainers/gianiaz)

---

Top Contributors

[![evert](https://avatars.githubusercontent.com/u/178960?v=4)](https://github.com/evert "evert (46 commits)")[![ericdowell](https://avatars.githubusercontent.com/u/525506?v=4)](https://github.com/ericdowell "ericdowell (3 commits)")[![assertchris](https://avatars.githubusercontent.com/u/200609?v=4)](https://github.com/assertchris "assertchris (1 commits)")[![jelmersnoeck](https://avatars.githubusercontent.com/u/815655?v=4)](https://github.com/jelmersnoeck "jelmersnoeck (1 commits)")

---

Tags

phpphpdocmarkdown

### Embed Badge

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

```
[![Health](https://phpackages.com/badges/gianiaz-phpdoc-md/health.svg)](https://phpackages.com/packages/gianiaz-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)