aceraven777/laravel-db-doc-generator

laravel 数据库文档生成器

dev-master 2023-02-20 08:38 UTC

This package is auto-updated.

Last update: 2024-09-20 11:56:18 UTC


README

Maintainability StyleCI Latest Stable Version License

要求

  • laravel 5.5+
  • Tokenizer 扩展

入门

安装

该包可在 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 时,有一些命令行选项

  1. --output,指定生成文档的目录。
  2. --model-path,指定搜索 Eloquent 模型文件的目录。
  3. --excluded-dir,指定在搜索中忽略的目录。
  4. --lang,指定文档语言。