{"id":13828234,"url":"https://github.com/lluiscamino/phpDoc2pdf","last_synced_at":"2025-07-09T06:31:17.407Z","repository":{"id":62518392,"uuid":"178461127","full_name":"lluiscamino/phpDoc2pdf","owner":"lluiscamino","description":"Create PDF formatted documentation for your PHP projects","archived":false,"fork":false,"pushed_at":"2019-06-23T11:43:11.000Z","size":158,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-20T09:13:38.446Z","etag":null,"topics":["hacktoberfest","pdf","php","phpdoc","phpdoc-pdf","phpdocumentor"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lluiscamino.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-29T18:58:06.000Z","updated_at":"2024-07-03T13:20:59.000Z","dependencies_parsed_at":"2022-11-02T10:31:40.492Z","dependency_job_id":null,"html_url":"https://github.com/lluiscamino/phpDoc2pdf","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/lluiscamino/phpDoc2pdf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lluiscamino%2FphpDoc2pdf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lluiscamino%2FphpDoc2pdf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lluiscamino%2FphpDoc2pdf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lluiscamino%2FphpDoc2pdf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lluiscamino","download_url":"https://codeload.github.com/lluiscamino/phpDoc2pdf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lluiscamino%2FphpDoc2pdf/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264406023,"owners_count":23603054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","pdf","php","phpdoc","phpdoc-pdf","phpdocumentor"],"created_at":"2024-08-04T09:02:37.717Z","updated_at":"2025-07-09T06:31:17.108Z","avatar_url":"https://github.com/lluiscamino.png","language":"PHP","readme":"# phpDoc2pdf\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/lluiscamino/phpDoc2pdf/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/lluiscamino/phpDoc2pdf/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/lluiscamino/phpDoc2pdf/badges/build.png?b=master)](https://scrutinizer-ci.com/g/lluiscamino/phpDoc2pdf/build-status/master)\n\nCreate PDF formatted documentation for your PHP projects.\n\nphpDoc2pdf uses the [phpDocumentor/Reflection](https://github.com/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](https://github.com/phpDocumentor/phpDocumentor2) provides, but in PDF format.\n\nYou can see some examples on the [docs](/docs) folder.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Installing\n\n1. Download the PHAR file directly from [here](https://github.com/lluiscamino/phpDoc2pdf/releases).\n\n### Usage\n\nUse the following command to generate the documentation:\n\n```bash\nphp phpDoc2pdf.phar create \u003cINPUT\u003e \u003cOUTPUT\u003e\n```\n\nReplace ``\u003cINPUT\u003e`` with the PHP file or directory that you want to document and ``\u003cOUTPUT\u003e`` with the directory where the documentation will be saved.\n\nPlease note that the files you want to document have to be in UTF-8 format.\n\n## Built With\n\n* [phpDocumentor2/Reflection](https://github.com/phpDocumentor/Reflection)\n* [Symfony/Console](https://github.com/symfony/console)\n* [mpdf](https://github.com/mpdf/mpdf)\n* [thephpleague/plates](https://github.com/thephpleague/plates)\n* [erusev/parsedown](https://github.com/erusev/parsedown)\n* [sebastianbergmann/phpunit](https://github.com/sebastianbergmann/phpunit)\n\n## Contributing\n\nAll contributions are welcome, please see the To-do list below or suggest something. 🤗\n\n## To-do list\n\n- [x] Add tests\n- [x] Add markdown support\n- [x] Add templates system\n- [ ] Separate generated docs into different subdirectories\n- [x] Make installation and usage simpler\n- [ ] Include phpDocBlock types on method arguments\n- [ ] Add support for all type of file extensions.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n","funding_links":[],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flluiscamino%2FphpDoc2pdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flluiscamino%2FphpDoc2pdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flluiscamino%2FphpDoc2pdf/lists"}