masterinfoalberghi/laravel-db-doc-generator

laravel 数据库文档生成器

维护者

详细信息

github.com/masterinfoalberghi/laravel-db-doc-generator

源代码

安装: 2

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 4

4 2024-06-21 11:34 UTC

Requires

MIT c0d04ef557ab4991c5f4aa14970050447fa44b43

  • Churakov Mike

laraveldatabase documentationlaravel documentation

This package is auto-updated.

Last update: 2024-09-21 11:59:47 UTC

README

Maintainability StyleCI Latest Stable Version License

要求

  • 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 时有一些命令行选项：

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