Download the PHP package nelson6e65/phpdoc-vuepress without Composer
On this page you can find all versions of the php package nelson6e65/phpdoc-vuepress. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nelson6e65/phpdoc-vuepress
More information about nelson6e65/phpdoc-vuepress
Files in nelson6e65/phpdoc-vuepress
Package phpdoc-vuepress
Short Description Template for generating your PHP API documentation in a pretty VuePress format.
License MIT
Homepage https://github.com/nelson6e65/phpdoc-vuepress
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phpdoc-vuepress
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 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 https://phpdoc-vuepress.netlify.app/demo
Explore sources of nelson6e65/phpdoc-vuepress to use configuration files as guide.
A real project API generated using this template: nelson6e65/php_nml.
Requirements
- PHP >= 5.6 < 8.0
- Node.js >= 8 < 18
- phpDocumentor 2.
- Yarn (or npm)
- VuePress.
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:
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:
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/.
Contributing
Check out the CONTRIBUTING.md file for details about contributing.
License
Copyright (c) 2018-2023 Nelson Martell
Read the LICENSE file for details.
Note: This template is based on Markdown template created by @cvuorinen: cvuorinen/phpdoc-markdown-public.
