Introduction

PHPDoc-VuePress

Template for generating your PHP API documentation in a pretty VuePress format.

This package provides a phpDocumentor template to generate the API documentation of your code to be integrated in a nice looking VuePress (opens new window) project.

Only tested with the default theme of VuePress.

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.

Demos

Check a demo of documentation generated with this template in Demo

Real projects using this template:

• PHP: Nelson Martell Library - https://php-nml.netlify.app/api (opens new window).

Do you use this template? Add it here! 😀

License

Copyright (c) 2018-2023 Nelson Martell

Read the LICENSE file (opens new window) for details.

Note: This template is based on Markdown template created by @cvuorinen (opens new window): cvuorinen/phpdoc-markdown-public (opens new window).