PHPackages                             gkcgautam/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. gkcgautam/phpdoc-md

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

gkcgautam/phpdoc-md
===================

PHP documentation generator, with markdown output

0.1.0(11y ago)1251MITPHPPHP >=5.3.1

Since Nov 2Pushed 11y ago1 watchersCompare

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

READMEChangelogDependencies (2)Versions (9)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 and PHP 5.3 namespaces. The project was primarily developed for [SabreDAV](https://github.com/evert/sabreDAV), 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" : {

    "gkcgautam/phpdoc-md" : "~0.0.7"

}

```

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

```

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

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

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.8% 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 ~95 days

Recently: every ~166 days

Total

8

Last Release

4277d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/01fc4da2392b79e70017c5c702a92dd4eca88d542e469521b2d6371703252b03?d=identicon)[gkcgautam](/maintainers/gkcgautam)

---

Top Contributors

[![evert](https://avatars.githubusercontent.com/u/178960?v=4)](https://github.com/evert "evert (31 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/gkcgautam-phpdoc-md/health.svg)

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