2017 © Pedro Peláez
 

library phpdoc-md

PHP documentation generator, with markdown output

image

evert/phpdoc-md

PHP documentation generator, with markdown output

  • Monday, June 25, 2018
  • by evert
  • Repository
  • 9 Watchers
  • 130 Stars
  • 84,607 Installations
  • PHP
  • 78 Dependents
  • 0 Suggesters
  • 43 Forks
  • 5 Open issues
  • 11 Versions
  • 13 % Grown

The README.md

PHPDocumentor MarkDown export

This is a script that can generate markdown (.md) files for your API documentation., (*1)

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., (*2)

It only documents classes and interfaces., (*3)

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)., (*4)

Installation

This project assumes you have composer installed. Simply add:, (*5)

"require-dev" : {

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

}

To your composer.json, and then you can simply install with:, (*6)

composer install

Usage

First ensure that phpdocumentor 2 is installed somewhere, after, you must generate a file called structure.xml., (*7)

The easiest is to create a temporary directory, for example named docs/., (*8)

# 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., (*9)

Cheers, Evert, (*10)

The Versions

25/06 2018

dev-master

9999999-dev https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot

php phpdoc markdown

11/02 2016

0.2.0

0.2.0.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot

php phpdoc markdown

27/03 2015

0.1.1

0.1.1.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot

php phpdoc markdown

01/09 2014

0.1.0

0.1.0.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot

php phpdoc markdown

11/02 2013

0.0.7

0.0.7.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

07/11 2012

0.0.6

0.0.6.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

07/11 2012

0.0.5

0.0.5.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.4

0.0.4.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.3

0.0.3.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.2

0.0.2.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

02/11 2012

0.0.1

0.0.1.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown