{"repo":"Saggre/phpDocumentor-markdown","free":true,"listed":false,"github":"https://github.com/Saggre/phpDocumentor-markdown","clone":"git clone https://github.com/Saggre/phpDocumentor-markdown.git","description":"Generate Markdown documentation from PHP code","language":"Twig","stars":22,"topics":["documentation","github","gitlab","markdown","phpdoc","phpdocumentor"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"phpDocumentor-markdown - Automatically generate Markdown documentation Use cases: In-repository documentation, GitHub/GitLab wikis, AI prompt context. Markdown template for phpDocumentor3 Wish there was an easy way to generate PHP source code documentation? \\ Using phpDocumentor with phpDocumentor-markdown template, you can automatically generate GitHub/GitLab-ready Markdown documentation from PHP source code. This template can be used to document: Name Descriptions Inheritance Implements Constants Properties Methods Inherited methods ------------ ------ -------------- ------------- ------------ ----------- ------------ --------- ------------------- Classes ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ Interfaces ✅ ✅ ✅ ➖ ✅ ✅ ✅ ➖ Traits ✅ ✅ ➖ ➖ ✅ ✅ ✅ ➖ Name Descriptions Types (parameter, return, etc.) Access modifiers ------------ ------ -------------- --------------------------------- ------------------ Functions ✅ ✅ ✅ ✅ Methods ✅ ✅ ✅ ✅ Properties ✅ ✅ ✅ ✅ Example Examples are available in the .wiki directory. Installation & Usage - Please refer to this guide for instructions on installing phpDocumentor. - Usage instructions assume that phpdoc is the phpDocumentor binary. Running manually Using Composer Installation via Composer Running manually after installing via Composer Installation & Usage tips 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 phpDocumento","default_branch":null,"files":null,"tree":[],"storefront":"/r/Saggre","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Saggre/phpDocumentor-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}