Download the PHP package automattic/phpdoc-markdown without Composer
On this page you can find all versions of the php package automattic/phpdoc-markdown. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download automattic/phpdoc-markdown
More information about automattic/phpdoc-markdown
Files in automattic/phpdoc-markdown
Package phpdoc-markdown
Short Description phpDocumentor v3 template that generates Markdown documentation for Github.
License MIT
Homepage https://github.com/automattic/phpdoc-markdown
Informations about the package phpdoc-markdown
phpDocumentor v3 markdown template
phpDocumentor v3 template that generates Markdown documentation.
This is a heavily modified version of a phpDocumentor v2 markdown template.
The main use-case for this template is to generate simple and nice looking usage documentation, that can then be published on GitHub/GitLab.
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.
Installation
Install with composer:
Usage
Run phpDocumentor and set template as vendor/automattic/phpdoc-markdown/data/templates/markdown
.
Example using configuration file:
Add a file called phpdoc.xml
(or phpdoc.dist.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. You can read more about phpDocumentor v3 configuration here.
After you've created the configuration file, you can now run phpdoc without arguments, then run the php script to fix the generated files.
Or, you can add it to your composer.json scripts section, this is how I do it.
Then run: