nelson6e65/phpdoc-vuepress

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


README

Card

PHPDoc-VuePress

Travis Build Status PHP Versions

GitHub release Latest Version Latest unstable Version

License Documentation Wakatime

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 project.

WIP: 🚧🏗 Compatibility with phpDocumentor 3 in progress.

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

Check a demo of documentation generated with this template in http://nelson6e65.github.io/phpdoc-vuepress/demo/

Explore sources of nelson6e65/phpdoc-vuepress to use configuration files as guide.

A real project API generated using this template: nelson6e65.github.io/php_nml/api/.

Requirements

This template is designed for phpDocumentor 2 and VuePress 1. Read more about dependencies in the Documentation.

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

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 to 'dev' or 'beta' in order to be able to install pre-releases.

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.

Configuration

See the Configuration section in the documentation for setup examples.

Further reading

Check the documentation for more information https://nelson6e65.github.io/phpdoc-vuepress/.

License

License

Copyright (c) 2018-2021 Nelson Martell

Read the LICENSE file for details.

Note: This template is based on Markdown template created by @cvuorinen: cvuorinen/phpdoc-markdown-public.