Download the PHP package artarts36/artisan-documentator without Composer
On this page you can find all versions of the php package artarts36/artisan-documentator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download artarts36/artisan-documentator
More information about artarts36/artisan-documentator
Files in artarts36/artisan-documentator
Package artisan-documentator
Short Description Laravel Artisan Documentator
License MIT
Informations about the package artisan-documentator
Artisan Documentator
This package provides generate documentation about your app console commands.
Installation
Run commands:
composer require --dev artarts36/artisan-documentator
php artisan vendor:publish --provider="ArtARTs36\ArtisanDocumentator\Providers\ArtisanDocumentatorServiceProvider" --tag=config
Console commands
After installation, you can run command php artisan command:doc {path}
. Example: php artisan command:doc docs/command.md
Configuration
You can set command's namespaces in the file: config/artisan_documentator.php
in section 'namespaces':
Using in CI
In order to use generation in CI you need to specify your login and token in the file in the file: config/artisan_documentator.php
in section 'git.remotes':
Command call in your CI conf file:
php artisan command:doc docs/command.md --ci
Command Description
Must fill property description
in console commands for full documentation.
Use the PHP CS Fixer rule PhpCsFixerGoodFixers/laravel_command_no_empty_description
to prevent undescribed commands from entering your repository.
All versions of artisan-documentator with dependencies
illuminate/config Version ^8.0
illuminate/console Version ^8.0
illuminate/filesystem Version ^8.69
illuminate/support Version ^8.0