evangellion / phpdoc-md

PHPDocumentor Markdown generator

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, 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

This project assumes you have composer installed. Simply add:

"require-dev" : {

    "evert/phpdoc-md" : "0.0.*"

}

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

composer install --dev

Usage

# You must have phpdocumentor2 installed.
# First generate a structure.xml file with phpdocumentor.
# This command will generate structure.xml in the current directory.
phpdoc parse -t . -d [project path]

# Next, run phpdocmd:
{$argv[0]} structure.xml [outputdir]

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