PHPackages linchpin/phpdocumentor-template-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. [Templating & Views](/categories/templating) 4. / 5. linchpin/phpdocumentor-template-markdown ActiveLibrary[Templating & Views](/categories/templating) linchpin/phpdocumentor-template-markdown ======================================== phpDocumentor Template for github Wiki. Forked from oliveratgithub/phpDocumentor-Template-ghwiki 1.0.0(5y ago)021.6k↓61.4%1GPL-3.0-or-laterTwig Since Jun 11Pushed 5y agoCompare [ Source](https://github.com/linchpin/phpdocumentor-template-markdown)[ Packagist](https://packagist.org/packages/linchpin/phpdocumentor-template-markdown)[ Docs](https://github.com/linchpin/phpDocumentor-Template-ghwiki)[ RSS](/packages/linchpin-phpdocumentor-template-markdown/feed)WikiDiscussions master Synced 3d ago READMEChangelog (1)DependenciesVersions (2)Used By (1) GitHub Wiki-Template for phpDocumentor ====================================== [](#github-wiki-template-for-phpdocumentor) Introduction ------------ [](#introduction) This is a custom template to use with [phpDocumentor](https://github.com/phpDocumentor/phpDocumentor). It is intended to create the code documentation as markdown files, fully compatible to serve as a [GitHub Wiki](https://help.github.com/en/github/building-a-strong-community/about-wikis) in a GitHub repository of your choice. ### Example [](#example) You can find a live example in this GitHub repository: [zorgch/zorg-code/wiki](https://github.com/zorgch/zorg-code/wiki) Installation ------------ [](#installation) 1. Via composer `composer require linchpin/phpdocumentor-template-markdown` 2. Download the latest release ### Pre-requisites [](#pre-requisites) - [phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) must be installed or available using its `.phar` - You have a GitHub Wiki [cloned locally](https://help.github.com/en/github/building-a-strong-community/adding-or-editing-wiki-pages#adding-or-editing-wiki-pages-locally) ### Generate GitHub Wiki Markdown from your code [](#generate-github-wiki-markdown-from-your-code) 2. Specifiy this template `phpdocumentor-template-markdown` while generating your code documentation using `phpDocumentor`: `php ./phpDocumentor.phar -d "/path/to/my/sourcecode" -t "/path/to/local/github-wiki" --template="/vendor/linchpin/phpdocumentor-template-markdown" --cache-folder "/path/to/store/cache" --title "My code project"` - *NOTE*: you may get an error at the end of the parsing - which you can just ignore, all work was done: `ERROR In PathGenerator.php line 120: Variable substitution in path /namespaces/{{name}}.md failed, variable "name" did not return a value` 3. The target directory `/github-wiki` consists of various markdown (.md) files now 4. Review, commit & push your local GitHub Wiki repository changes 5. Browse to the Wiki on the corresponding GitHub repository to see your code documentation online ### Result [](#result) Consider that GitHub Wiki pages are in a flat file hierarchy. Fortunately you still can use folders in the repository itself - so you can have a clean structure in the Wiki repository, but when linking between files it must behave like all Wiki pages are in a single, flat hierarchy. #### Outputted file hierarchy [](#outputted-file-hierarchy) The output consists of the following files hierarchy: #### GitHub Wiki pages handling [](#github-wiki-pages-handling) As mentioned, due to GitHub Wiki pages behaving not within any hierarchy, linking between Wiki pages is done... - by referencing the file name of the page - leaving away the `.md` extension So use `class-MyClass` to link to the file `/wiki/classes/class-MyClass.md`. Or `file-myconfigs.inc.php` to link to the file `/wiki/files/file-myconfigs.inc.php.md`. ### Health Score 30 — LowBetter than 62% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity27 Limited adoption so far Community10 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 60% 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 Unknown Total 1 Last Release 1849d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/d2b96b478462e0558027f2d74020598a5053431dc3ae499f12cfc1799f9a3d69?d=identicon)[aware](/maintainers/aware) --- Top Contributors [![oliveratgithub](https://avatars.githubusercontent.com/u/280207?v=4)](https://github.com/oliveratgithub "oliveratgithub (9 commits)")[![aaronware](https://avatars.githubusercontent.com/u/3390827?v=4)](https://github.com/aaronware "aaronware (6 commits)") ### Embed Badge ![Health badge](/badges/linchpin-phpdocumentor-template-markdown/health.svg) ``` [![Health](https://phpackages.com/badges/linchpin-phpdocumentor-template-markdown/health.svg)](https://phpackages.com/packages/linchpin-phpdocumentor-template-markdown) ``` ### Alternatives [limenius/react-bundle Client and Server-side react rendering in a Symfony Bundle 3851.2M](/packages/limenius-react-bundle)[area17/laravel-auto-head-tags Laravel Auto Head Tags helps you build the list of head elements for your app 4616.1k](/packages/area17-laravel-auto-head-tags)[ktquez/laravel-tinymce TinyMCE editor for Laravel and Lumen Framework 2525.4k](/packages/ktquez-laravel-tinymce)[jelix/wikirenderer WikiRenderer is a library to generate HTML or anything else from wiki content. 1712.3k1](/packages/jelix-wikirenderer)[webkinder/sproutset A Composer package for handling responsive images in Roots Bedrock + Sage + Blade projects. 282.2k](/packages/webkinder-sproutset) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)