- laravel 5.5+
- Tokenizer Extension
The package is available on packagist.
composer require churakovmike/laravel-db-doc-generator
or
php composer.phar require churakovmike/laravel-db-doc-generator
Register service provider in config/app.php
ChurakovMike\DbDocumentor\DbDocumentorServiceProvider::class,
Run in from command-line with next command
php artisan db-doc:generate
By default database documentation will be generate in ./public/db-doc/ If you need to change output destination, run command with --output argument
php artisan db-doc:generate --output=path/to/your/destination
When running DbDocumentor there are some command-line options
--output
, specifies the directory to output generated documentation.--model-path
, specifies the directory for searching Eloquent model files.--excluded-dir
, specifies the directories to ignore during the search.--lang
, specifies the documentation language.