2017 © Pedro Peláez
 

library phpdoc-md

PHP documentation generator, with markdown output

image

cvuorinen/phpdoc-md

PHP documentation generator, with markdown output

  • Monday, December 14, 2015
  • by cvuorinen
  • Repository
  • 0 Watchers
  • 0 Stars
  • 29 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 23 Forks
  • 0 Open issues
  • 11 Versions
  • 12 % Grown

The README.md

phpDocumentor Markdown export

This is a script that can generate markdown (.md) documentation files from your DocBlock comments., (*1)

It is tailored for projects using PSR-0, PSR-1, PSR-2, PSR-4 and namespaces., (*2)

This is based on the work of Evert Pot in https://github.com/evert/phpdoc-md., (*3)

Note! This package has been superseded by https://github.com/cvuorinen/phpdoc-markdown-public, (*4)

Installation

Install with composer:, (*5)

composer require cvuorinen/phpdoc-md

Usage

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

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

# 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".

--title [title]
    This specifies the title for the generated Markdown document.

The Versions

14/12 2015

dev-master

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

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot
by Carl Vuorinen

php phpdoc markdown

12/11 2015

0.1.2

0.1.2.0 https://github.com/cvuorinen/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot
by Carl Vuorinen

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