laravox / documentor
Easy way to document your laravel projects!
v1.0.2
2022-02-13 19:27 UTC
This package is auto-updated.
Last update: 2025-06-14 04:43:22 UTC
README
Steps to install
- You need to install phive (https://github.com/phar-io/phive)
- phive install --force-accept-unsigned phpDocumentor
- install the package:
composer require laravox/documentor
- add the next attribute in your app/Console/Kernel.php file:
protected $commands = [ \Laravox\Documentor\Console\Commands\DocumentorBuildCommand::class, ];
How to use it?
php artisan documentor:build {source?} {destiny?}
The {source?}
variable allows you to specify the folder which will be documented
The {destiny?}
variable allows you to specify the folder where the documentation will be stored.
Both variables are optional.
The default value for {source}
is the app/
folder.
The default value for {destiny}
is the docs/
folder.
Any issue or suggestion is welcomedto improve this repository.