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

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

cvuorinen/phpdoc-markdown-public
================================

phpDocumentor template that generates Markdown documentation of the public API

0.2.0(8y ago)3513.8k27[4 issues](https://github.com/cvuorinen/phpdoc-markdown-public/issues)20MITHTML

Since Dec 14Pushed 4y ago3 watchersCompare

[ Source](https://github.com/cvuorinen/phpdoc-markdown-public)[ Packagist](https://packagist.org/packages/cvuorinen/phpdoc-markdown-public)[ Docs](https://github.com/cvuorinen/phpdoc-markdown-public)[ RSS](/packages/cvuorinen-phpdoc-markdown-public/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (1)Versions (5)Used By (20)

phpDocumentor markdown-public template
======================================

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

[phpDocumentor template](http://www.phpdoc.org/docs/latest/getting-started/changing-the-look-and-feel.html) that generates Markdown documentation of only the public API. It will skip all abstract classes and non-public methods.

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

Usage
-----

[](#usage)

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

**Example using command-line arguments:**

```
./vendor/bin/phpdoc --directory=src/ --target=docs/ --template="vendor/cvuorinen/phpdoc-markdown-public/data/templates/markdown-public" --title="My Project Documentation"
```

More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).

**Example using configuration file:**

Add a file called `phpdoc.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.

```

    My Project Documentation

        build

        docs

        src
        test/*

```

More information about [configuring phpDocumentor](http://www.phpdoc.org/docs/latest/references/configuration.html).

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community25

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~250 days

Total

4

Last Release

3094d ago

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

phpdocdocumentationphpDocumentormarkdown

### Embed Badge

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

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

###  Alternatives

[daux/daux.io

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

825195.5k1](/packages/daux-dauxio)[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

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

Documentation Generator for WordPress.

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

Markdown template for phpDocumentor3

2293.1k41](/packages/saggre-phpdocumentor-markdown)[clean/phpdoc-md

Parse PHP classes and writes documentation to markdown files

44136.1k44](/packages/clean-phpdoc-md)

PHPackages © 2026

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