每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了 这个扩展
,自动读取数据库信息
并显示在网页上,支持导出 Html
和 PDF
文件。
- 导出
Html
实际为生成并导出一个离线版本的压缩包。- 导出
- 导出
Markdown
为数据表增加了锚点链接。
安装
-
安装包文件
$ composer require jormin/laravel-ddoc
配置
-
注册 ServiceProvider:
Jormin\DDoc\DDocServiceProvider::class,
``
-
创建配置文件:
php artisan vendor:publish
``
执行命令后会在
config
目录下生成两个文件:-
laravel-ddoc.php
:本扩展配置文件,用于配置文档底部Copyright
文案和链接。 -
snappy.php
:laravel-snappy 的配置文件,用于配置导出pdf
的选项。pdf.binary
项配置wkhtmltopdf
执行文件的目录linux/unix/mac
系统的执行文件存放于项目目录/vendor/h4cc/wkhtmltopdf-[amd64|i386]/bin/
目录下wundiws
系统的执行文件存放于项目目录/vendor/wemersonjanuario/wkhtmltopdf-windows/bin/[64bit|32bit]/
目录下
-
使用
安装扩展后,浏览器访问 [http|https]://[your domain or ip]/ddoc
参考问题
-
Q:导出的
PDF
文件中文不显示或者乱码?A:导致此问题的原因是机器上没有安装中文字体,解决方式如下
1、先从本机或者网络上下载所需的中文字体 2、修改字体文件的权限,使root用户以外的用户也可以使用 $ cd /usr/share/fonts/chinese/ 3、建立字体缓存 $ sudo mkfontscale $ # 如果提示 mkfontscale: command not found,则需要安装# sudo apt-get install ttf-mscorefonts-installer $ sudo mkfontdir $ sudo fc-cache -fv $ # 如果提示 fc-cache: command not found,则需要安装# sudo apt-get install fontconfig
``
参考图
The MIT License (MIT). Please see License File for more information.