Create PDF formatted documentation for your PHP projects.
phpDoc2pdf uses the phpDocumentor/Reflection library to extract the classes, interfaces and traits from your project and generate a set of documentation similar to the one that phpDocumentor2 provides, but in PDF format.
You can see some examples on the docs folder.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Download the PHAR file directly from here.
Use the following command to generate the documentation:
php phpDoc2pdf.phar create <INPUT> <OUTPUT>Replace <INPUT> with the PHP file or directory that you want to document and <OUTPUT> with the directory where the documentation will be saved.
Please note that the files you want to document have to be in UTF-8 format.
- phpDocumentor2/Reflection
- Symfony/Console
- mpdf
- thephpleague/plates
- erusev/parsedown
- sebastianbergmann/phpunit
All contributions are welcome, please see the To-do list below or suggest something. 🤗
- Add tests
- Add markdown support
- Add templates system
- Separate generated docs into different subdirectories
- Make installation and usage simpler
- Include phpDocBlock types on method arguments
- Add support for all type of file extensions.
This project is licensed under the MIT License - see the LICENSE file for details