Download the PHP package linchpin/phpdocumentor-markdown-template without Composer
On this page you can find all versions of the php package linchpin/phpdocumentor-markdown-template. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download linchpin/phpdocumentor-markdown-template
More information about linchpin/phpdocumentor-markdown-template
Files in linchpin/phpdocumentor-markdown-template
Package phpdocumentor-markdown-template
Short Description Markdown template for phpDocumentor3 based on Saggre/phpDocumentor-markdown
License MIT
Informations about the package phpdocumentor-markdown-template
phpDocumentor - Generate GitHub/GitLab-Ready Markdown Documentation
Markdown template for phpDocumentor 3.x
Have you ever wished there was an easier way to generate documentation for your PHP source code? Well, now there is! With phpDocumentor and phpDocumentor-markdown, you can automatically generate GitHub/GitLab-ready Markdown documentation from your PHP source code. This template can be used to document classes, interfaces, traits, constants, properties and methods.
Example
An example is available in the example directory.
Installation & Usage
- Please refer to this guide for instructions on installing phpDocumentor.
- Usage instructions assume that
phpDocumentor
is the phpDocumentor 3.x binary.
Running manually
Using Composer
Installation via Composer
Running manually after installing via Composer
Adding a Composer helper script
Add this script to your composer.json
and run composer create-docs
to generate the documentation.
Using with PhpDocumentor XML config
Add a template element to your phpDocumentor XML config and run phpDocumentor
to generate the documentation.
You can also check out the config file used for generating this repository's example documentation for a full example.
Running tests
Contributing
- Use PSR-12 coding style
- Twig extensions do not yet work with phpDocumentor3, so custom functionality is created with Twig macros.
- The test suite uses Twig extensions to test the Twig macro functionality.
- Check
\phpDocumentor\Descriptor\ProjectDescriptor
for data structure used to generate the documentation.