skayo/phpdoc-md

PHP documentation generator, with markdown output

0.2.5 2018-06-23 23:32 UTC

This package is auto-updated.

Last update: 2022-05-01 00:13:10 UTC


README

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, 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" : {

    "skayo/phpdoc-md" : "~0.2.0"

}

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

composer install

But I recommend to just install it globally with this command:

composer global require skayo/phpdoc-md

This ensures that you can use the phpdocmd command everywhere on your computer.

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

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