PHPackages nelson6e65/phpdoc-vuepress - 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. nelson6e65/phpdoc-vuepress ActiveLibrary[Parsing & Serialization](/categories/parsing) nelson6e65/phpdoc-vuepress ========================== Template for generating your PHP API documentation in a pretty VuePress format. v1.0.1(5y ago)224.6k1[8 issues](https://github.com/nelson6e65/phpdoc-vuepress/issues)[14 PRs](https://github.com/nelson6e65/phpdoc-vuepress/pulls)2MITTwig Since Dec 23Pushed 3y ago3 watchersCompare [ Source](https://github.com/nelson6e65/phpdoc-vuepress)[ Packagist](https://packagist.org/packages/nelson6e65/phpdoc-vuepress)[ Docs](https://github.com/nelson6e65/phpdoc-vuepress)[ RSS](/packages/nelson6e65-phpdoc-vuepress/feed)WikiDiscussions master Synced 4w ago READMEChangelog (5)Dependencies (2)Versions (22)Used By (2) [![Card](./.github/assets/card.svg)](https://nelson6e65.github.io/phpdoc-vuepress) PHPDoc-VuePress =============== [](#phpdoc-vuepress) [![Documentation build](https://camo.githubusercontent.com/93d93c45cca5d5e68c37258105af2d717fdbe1ff817c2092d5f9a2890552d29f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6e656c736f6e366536352f706870646f632d76756570726573732f646f63756d656e746174696f6e2e796d6c3f6c6162656c3d646f6373)](https://camo.githubusercontent.com/93d93c45cca5d5e68c37258105af2d717fdbe1ff817c2092d5f9a2890552d29f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6e656c736f6e366536352f706870646f632d76756570726573732f646f63756d656e746174696f6e2e796d6c3f6c6162656c3d646f6373) [![Packagist PHP Versions](https://camo.githubusercontent.com/e8aa1e686349f428d4e2d39a8bdd2b057a54ee65db23bcfcfe2df3a5951ea0bf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6e656c736f6e366536352f706870646f632d76756570726573732f706870)](https://camo.githubusercontent.com/e8aa1e686349f428d4e2d39a8bdd2b057a54ee65db23bcfcfe2df3a5951ea0bf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6e656c736f6e366536352f706870646f632d76756570726573732f706870) [![GitHub release](https://camo.githubusercontent.com/5c7ccde72b8f132eaf9cd2006a9b39b54c011274c94d938c7a91c1c37c7f9b54/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7461672f6e656c736f6e366536352f706870646f632d76756570726573732e737667)](https://github.com/nelson6e65/phpdoc-vuepress/tags)[![Latest Version](https://camo.githubusercontent.com/d9dd9fe90d78cdf33b3938f461f696776883a14d0a83095518ccd53de4047670/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6e656c736f6e366536352f706870646f632d76756570726573732e7376673f6c6162656c3d737461626c65)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress)[![Latest unstable Version](https://camo.githubusercontent.com/17584225244aad02b1a2cc562eac8ad20d2a74831f591b8656c2848725b64152/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f767072652f6e656c736f6e366536352f706870646f632d76756570726573732e7376673f6c6162656c3d756e737461626c65)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress#dev-master) [![License](https://camo.githubusercontent.com/4ec23806e7660fe19bf049c5f3db18b8976bb1dbcda2f7e680c9cd241ea837b3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e656c736f6e366536352f706870646f632d76756570726573732e737667)](LICENSE)[![Documentation](https://camo.githubusercontent.com/db3dd095b17cd7bd71c54b0dd76489e65c6c6399aba926fc44313540a4969270/687474703a2f2f696d672e736869656c64732e696f2f62616467652f2546302539462539332539432d446f63756d656e746174696f6e2d6c69676874677265792e737667)](https://phpdoc-vuepress.netlify.app/)[![Wakatime](https://camo.githubusercontent.com/0d561d839d28d9de0390b4509743995fb7c0cedb22fbeb417d7b473ba8af3bb7/68747470733a2f2f77616b6174696d652e636f6d2f62616467652f6769746875622f6e656c736f6e366536352f706870646f632d76756570726573732e737667)](https://wakatime.com/badge/github/nelson6e65/phpdoc-vuepress) Template for generating your PHP API documentation in a pretty VuePress format. This package provides a **phpDocumentor 2** template to generate the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project. > **WIP**: 🚧🏗 Compatibility with phpDocumentor 3 in progress. Features -------- [](#features) This template will generate six VuePress `*.md` files with the DocBlock documentation in your target directory: - `README.md`: Entry point of your API Documentation. Contains, at the moment, an introduction and references to blocks used in the site. - `classes.md`: Contains all classes, sorted by namespace. - `interfaces.md`: Contains all interfaces, sorted by namespace. - `traits.md`: Contains all traits, sorted by namespace. - `constants.md`: Contains all global constants, sorted by namespace. - `functions.md`: Contains all global functions, sorted by namespace. Demo ---- [](#demo) Check a demo of documentation generated with this template in Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/phpdoc-vuepress) to use configuration files as guide. > A real project API generated using this template: [nelson6e65/php\_nml](https://php-nml.netlify.app/api/). Requirements ------------ [](#requirements) - PHP >= 5.6 < 8.0 - Node.js >= 8 < 18 - [phpDocumentor](https://www.phpdoc.org/) 2. - [Yarn](https://yarnpkg.com) (or npm) - [VuePress](https://vuepress.vuejs.org/). > This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 1](https://v0.vuepress.vuejs.org/). Read more about dependencies in the [Documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/getting-started.html). > Note: phpDocumentor 2 is able to generate documentation of code written on maybe any version of PHP < 8, but should be run on PHP 7.2. You can configure a CI like Travis CI, Netlify of Github Actions to generate the documentation on PHP 7.2 for your code if not using it on your local environment. Compatibility with phpDocumentor 3 is in progress 🚧 to support new features it offers. Installation ------------ [](#installation) Install `nelson6e65/phpdoc-vuepress` with composer: ``` composer require --dev nelson6e65/phpdoc-vuepress ``` > **Note for pre-releases:** You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' or 'beta' in order to be able to install pre-releases. Usage ----- [](#usage) Run phpDocumentor and set template as `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`: ``` phpdoc -d="src/" -t="docs/api/" --template="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress" ``` > More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html). Configuration ------------- [](#configuration) See the [Configuration section in the documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/configuration.html) for setup examples. Further reading --------------- [](#further-reading) Check the documentation for more information . Contributing ------------ [](#contributing) Check out the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for details about contributing. License ------- [](#license) [![License](https://camo.githubusercontent.com/4ec23806e7660fe19bf049c5f3db18b8976bb1dbcda2f7e680c9cd241ea837b3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e656c736f6e366536352f706870646f632d76756570726573732e737667)](LICENSE) Copyright (c) 2018-2023 Nelson Martell Read the [`LICENSE` file](LICENSE) for details. > **Note:** This template is based on Markdown template created by [@cvuorinen](https://github.com/cvuorinen): [cvuorinen/phpdoc-markdown-public](https://github.com/cvuorinen/phpdoc-markdown-public). ### Health Score 36 — LowBetter than 79% of packages Maintenance13 Infrequent updates — may be unmaintained Popularity29 Limited adoption so far Community15 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor1 Top contributor holds 87% 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 ~252 days Recently: every ~373 days Total 7 Last Release 1271d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/c9776e1f12a0fcbe56bbb60b71b15ac1d62917b0415bbd68415e73428202eb66?d=identicon)[nelson6e65](/maintainers/nelson6e65) --- Top Contributors [![nelson6e65](https://avatars.githubusercontent.com/u/9272498?v=4)](https://github.com/nelson6e65 "nelson6e65 (180 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (27 commits)") --- Tags api-documentationcomposerdocblockphpphpdocphpdoc-vuepressphpdocumentorvuepressphpphpdocdocumentationphpDocumentormarkdownVuePress ### Embed Badge ![Health badge](/badges/nelson6e65-phpdoc-vuepress/health.svg) ``` [![Health](https://phpackages.com/badges/nelson6e65-phpdoc-vuepress/health.svg)](https://phpackages.com/packages/nelson6e65-phpdoc-vuepress) ``` ### Alternatives [evert/phpdoc-md PHP documentation generator, with markdown output 171175.6k96](/packages/evert-phpdoc-md)[cvuorinen/phpdoc-markdown-public phpDocumentor template that generates Markdown documentation of the public API 3614.0k29](/packages/cvuorinen-phpdoc-markdown-public)[dudo1985/wpdocgen Documentation Generator for WordPress. 2333.6k](/packages/dudo1985-wpdocgen) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)