README

从数据库模式生成Markdown文档和Laravel Eloquent模型类的核心库。

安装

使用Composer安装

composer require mileschou/schemarkdown

使用以下命令生成schema文档

cd /path/to/your-laravel-project
php artisan schema:markdown

Schema文档默认存储到docs/schema目录。使用--path选项来更改它。

在其他框架中，您必须提供类似于Laravel的配置文件。使用--config选项来指定自定义配置。

在加载配置之前，此工具将加载.env文件。使用--env选项来指定.env路径。

使用--database选项来指定Laravel配置中的connection name以生成一个数据库的文档。

如果想要覆盖已存在的文档，使用--overwrite选项。

使用以下命令来生成Eloquent模型

cd /path/to/your-laravel-project
php artisan schema:model

它将生成模型代码到app/Models目录（Laravel 8默认），使用--path选项可以更改输出目录。如果想要更改命名空间，使用--namespace选项。

在其他使用Eloquent ORM库的框架中，您必须提供类似于laravel项目的配置文件。使用--config选项来指定自定义配置。

如果只想构建一个连接，使用--database选项来指定。

如果想要覆盖已存在的代码，使用--overwrite选项。

这里是一个SQL示例，导入MySQL并运行以下命令

php artisan schemarkdown --config=tests/Fixtures/database.php --database=examples --output-dir=examples

它将生成这些Markdown文档。

使用-vv选项来查看信息日志。

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。