PHPackages aidilrx04/larecipe-phpdocumentor-markdown - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Parsing & Serialization](/categories/parsing) 4. / 5. aidilrx04/larecipe-phpdocumentor-markdown ActiveLibrary[Parsing & Serialization](/categories/parsing) aidilrx04/larecipe-phpdocumentor-markdown ========================================= Markdown template for phpDocumentor3 0.3.0(1y ago)013MITPHP Since Dec 20Pushed 1y agoCompare [ Source](https://github.com/aidilrx04/larecipe-phpDocumentor-markdown)[ Packagist](https://packagist.org/packages/aidilrx04/larecipe-phpdocumentor-markdown)[ RSS](/packages/aidilrx04-larecipe-phpdocumentor-markdown/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (2)Versions (4)Used By (0) phpDocumentor - Generate GitHub/GitLab-Ready Markdown Documentation =================================================================== [](#phpdocumentor---generate-githubgitlab-ready-markdown-documentation) Markdown template for phpDocumentor 3.x --------------------------------------- [](#markdown-template-for-phpdocumentor-3x) [![Tests Status](https://github.com/Saggre/phpDocumentor-markdown/workflows/Run%20tests/badge.svg?style=flat-square)](https://github.com/Saggre/phpDocumentor-markdown/workflows/Run%20tests/badge.svg?style=flat-square)[![Generate Docs Status](https://github.com/Saggre/phpDocumentor-markdown/workflows/Generate%20docs/badge.svg?style=flat-square)](https://github.com/Saggre/phpDocumentor-markdown/workflows/Generate%20docs/badge.svg?style=flat-square) Have you ever wished there was an easier way to generate documentation for your PHP source code? Well, now there is! With [phpDocumentor](https://www.phpdoc.org/) 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 ------- [](#example) An example is available in the [example](example/Home.md) directory. Installation & Usage ------------------------ [](#installation--usage) - Please refer to [this guide](https://docs.phpdoc.org/3.0/guide/getting-started/installing.html) for instructions on installing phpDocumentor. - Usage instructions assume that `phpDocumentor` is the phpDocumentor 3.x binary. ### Running manually [](#running-manually) ``` # Run phpDocumentor with --template argument pointed to this directory's markdown template phpDocumentor --directory=src --target=docs --template= ``` ### Using Composer [](#using-composer) #### Installation via Composer [](#installation-via-composer) ``` # Require this package. You probably want it as a dev dependency composer require --dev saggre/phpdocumentor-markdown ``` #### Running manually after installing via Composer [](#running-manually-after-installing-via-composer) ``` # Run phpDocumentor with --template argument pointed to markdown template inside vendor directory phpDocumentor --directory=src --target=docs --template="vendor/saggre/phpdocumentor-markdown/themes/markdown" ``` #### Adding a Composer helper script [](#adding-a-composer-helper-script) Add this script to your `composer.json` and run `composer create-docs` to generate the documentation. ``` "scripts": { "create-docs": "phpDocumentor --directory=src --target=docs --template='vendor/saggre/phpdocumentor-markdown/themes/markdown'" }, ``` #### Using with PhpDocumentor XML config [](#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](./phpdoc.dist.xml) used for generating this repository's example documentation for a full example. Running tests ------------- [](#running-tests) ``` # Clone the repository git clone git@github.com:Saggre/phpDocumentor-markdown.git # Go to the cloned repository cd phpDocumentor-markdown # Install dependencies composer install # Set up PHPUnit configuration cp phpunit.xml.dist phpunit.xml # Run PHPUnit in project root directory composer test ``` Contributing ------------ [](#contributing) - Use PSR-12 coding style - Twig extensions do not yet work with phpDocumentor3 ([See #3041](https://github.com/phpDocumentor/phpDocumentor/pull/3041)), so custom functionality is created with [Twig macros](./themes/markdown/include/macros.twig). - The test suite uses Twig extensions to test the Twig macro functionality. - Check [`\phpDocumentor\Descriptor\ProjectDescriptor`](https://github.com/phpDocumentor/phpDocumentor/blob/master/src/phpDocumentor/Descriptor/ProjectDescriptor.php) for data structure used to generate the documentation. Inspired by: ------------ [](#inspired-by) - [dmarkic/phpdoc3-template-md](https://github.com/dmarkic/phpdoc3-template-md) - [cvuorinen/phpdoc-markdown-public](https://github.com/cvuorinen/phpdoc-markdown-public) - [evert/phpdoc-md](https://github.com/evert/phpdoc-md) - [heimrichhannot/phpdoc-github-template](https://github.com/heimrichhannot/phpdoc-github-template) ### Health Score 22 — LowBetter than 22% of packages Maintenance41 Moderate activity, may be stable Popularity5 Limited adoption so far Community9 Small or concentrated contributor base Maturity30 Early-stage or recently created project Bus Factor1 Top contributor holds 85.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~5 days Total 3 Last Release 495d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/df98ba95d04a6fedea989d24dda0b05fceee5138c6baec1c261ae9d9bbb85778?d=identicon)[aidilrx04](/maintainers/aidilrx04) --- Top Contributors [![Saggre](https://avatars.githubusercontent.com/u/13721842?v=4)](https://github.com/Saggre "Saggre (47 commits)")[![aidilzohl](https://avatars.githubusercontent.com/u/185904300?v=4)](https://github.com/aidilzohl "aidilzohl (7 commits)")[![individual-it](https://avatars.githubusercontent.com/u/2425577?v=4)](https://github.com/individual-it "individual-it (1 commits)") --- Tags phpdocdocumentationphpDocumentormarkdowngithubgitlab ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/aidilrx04-larecipe-phpdocumentor-markdown/health.svg) ``` [![Health](https://phpackages.com/badges/aidilrx04-larecipe-phpdocumentor-markdown/health.svg)](https://phpackages.com/packages/aidilrx04-larecipe-phpdocumentor-markdown) ``` ### Alternatives [league/commonmark Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM) 2.9k404.0M702](/packages/league-commonmark)[daux/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 825191.0k1](/packages/daux-dauxio)[ion-bazan/composer-diff Compares composer.lock changes and generates Markdown report so you can use it in PR description. 1861.8M3](/packages/ion-bazan-composer-diff)[cvuorinen/phpdoc-markdown-public phpDocumentor template that generates Markdown documentation of the public API 3613.8k14](/packages/cvuorinen-phpdoc-markdown-public)[nelson6e65/phpdoc-vuepress Template for generating your PHP API documentation in a pretty VuePress format. 224.5k2](/packages/nelson6e65-phpdoc-vuepress)[dudo1985/wpdocgen Documentation Generator for WordPress. 2327.6k](/packages/dudo1985-wpdocgen) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)