PHPackages                             onspli/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. onspli/phpdoc-markdown

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

onspli/phpdoc-markdown
======================

Generate documentation in Markdown format so it can be published in GitHub.

0.3.3(4y ago)335.2k↓22.5%5MITTwig

Since Dec 14Pushed 4y agoCompare

[ Source](https://github.com/onspli/phpdoc-markdown)[ Packagist](https://packagist.org/packages/onspli/phpdoc-markdown)[ RSS](/packages/onspli-phpdoc-markdown/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)DependenciesVersions (9)Used By (5)

phpdoc markdown templates
=========================

[](#phpdoc-markdown-templates)

[phpDocumentor](https://phpdoc.org/) template that generates Markdown documentation of the **public API** only to a **single README.md file**. It will skip all abstract classes and non-public methods. Fork of template [cvuorinen/phpdoc-markdown-public](https://github.com/cvuorinen/phpdoc-markdown-public) by Carl Vuorinen.

The main use-case for this template is to generate simple and nice looking usage documentation, that can then be published on GitHub.

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.

Example of documentation generated with this template:

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

[](#installation)

Install with Composer:

```
composer require onspli/phpdoc-markdown
```

Usage
-----

[](#usage)

First, you need to install phpDocumentor. There are multiple options how to install it, one of them is using the PHAR:

```
$ wget https://phpdoc.org/phpDocumentor.phar
```

Read more about [installation of phpDocumentor](https://phpdoc.org/). Note that phpDocumentor is also available via Composer, however its documentation states

> Ah, you discovered our secret. There is a phpDocumentor composer package that you could use to install phpDocumentor.
>
> However: phpDocumentor is a complex application, and its libraries are used in countless other libraries and applications (2 of our libraries have more than 150 million downloads each); and this means that the chances for a conflict between one of our dependencies and yours is high. And when I say high, it is really high.
>
> So, because of the above: we do not endorse nor actively support installing phpDocumentor using Composer.

Next, run phpDocumentor and set template as `vendor/onspli/phpdoc-markdown/templates/public-onefile`.

```
$ php phpDocumentor.phar --directory=src --target=docs --template=vendor/onspli/phpdoc-markdown/templates/public-onefile
```

The documentation will be generated to `docs/README.md` file.

More information about [configuring phpDocumentor](https://docs.phpdoc.org/3.0/guide/references/configuration.html).

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity32

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 61.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 ~296 days

Recently: every ~330 days

Total

8

Last Release

1782d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/413b99f734b277cbf822e1726f13864540b9ae61e5dfe18154507605dc1af4ab?d=identicon)[onspli](/maintainers/onspli)

---

Top Contributors

[![onspli](https://avatars.githubusercontent.com/u/7120489?v=4)](https://github.com/onspli "onspli (21 commits)")[![cvuorinen](https://avatars.githubusercontent.com/u/1764167?v=4)](https://github.com/cvuorinen "cvuorinen (13 commits)")

---

Tags

phpdoctemplatephpdocdocumentationphpDocumentormarkdown

### Embed Badge

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

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

###  Alternatives

[daux/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

827199.0k1](/packages/daux-dauxio)[cvuorinen/phpdoc-markdown-public

phpDocumentor template that generates Markdown documentation of the public API

3513.9k29](/packages/cvuorinen-phpdoc-markdown-public)[nelson6e65/phpdoc-vuepress

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

234.6k2](/packages/nelson6e65-phpdoc-vuepress)[evert/phpdoc-md

PHP documentation generator, with markdown output

171174.8k95](/packages/evert-phpdoc-md)[dudo1985/wpdocgen

Documentation Generator for WordPress.

2332.3k](/packages/dudo1985-wpdocgen)[saggre/phpdocumentor-markdown

Markdown template for phpDocumentor3

2297.6k46](/packages/saggre-phpdocumentor-markdown)

PHPackages © 2026

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