churakovmike / laravel-db-doc-generator
为Laravel生成数据库文档
0.1
2020-05-16 15:46 UTC
Requires
- ext-tokenizer: *
- doctrine/dbal: 2.9.x-dev
- illuminate/console: ^5.5|^6|^7
- illuminate/contracts: ^5.5|^6|^7
- illuminate/database: ^5.5|^6|^7
- illuminate/http: ^5.5|^6|^7
- illuminate/pagination: ^5.5|^6|^7
- illuminate/support: ^5.5|^6|^7
- illuminate/view: ^5.5|^6|^7
This package is auto-updated.
Last update: 2024-09-29 06:02:40 UTC
README
需求
- laravel 5.5+
- 分词器扩展
入门
安装
该包可在Packagist上获取。
composer require churakovmike/laravel-db-doc-generator
或者
php composer.phar require churakovmike/laravel-db-doc-generator
在config/app.php中注册服务提供者
ChurakovMike\DbDocumentor\DbDocumentorServiceProvider::class,
用法
使用以下命令从命令行运行
php artisan db-doc:generate
默认情况下,数据库文档将生成在 ./public/db-doc/ 中。如果您需要更改输出目标,请使用 --output 参数运行命令
php artisan db-doc:generate --output=path/to/your/destination
在运行DbDocumentor时,有一些命令行选项
--output
,指定生成文档的目录。--model-path
,指定搜索Eloquent模型文件的目录。--excluded-dir
,指定在搜索中忽略的目录。--lang
,指定文档语言。