2017 © Pedro Peláez
 

library laravel-db-doc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

image

yunhantech/laravel-db-doc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  • Thursday, July 19, 2018
  • by raygu0101
  • Repository
  • 1 Watchers
  • 0 Stars
  • 34 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息 并显示在网页上,支持导出 HtmlPDFMarkdown 文件。, (*1)

  1. 导出 Html 实际为生成并导出一个离线版本的压缩包。
  2. 导出 PDF 使用了 laravel-snappy扩展包
  3. 导出 Markdown 为数据表增加了锚点链接。

安装

  1. 安装包文件, (*2)

    bash $ composer require --dev yunhanphp/lumen-dev-db-doc, (*3)

配置

  1. 注册 ServiceProvider:, (*4)

    Jormin\DDoc\DDocServiceProvider::class,
    
  2. 创建配置文件:, (*5)

    php artisan vendor:publish
    

    执行命令后会在 config 目录下生成两个文件:, (*6)

    • laravel-ddoc.php:本扩展配置文件,用于配置文档底部 Copyright 文案和链接。, (*7)

    • snappy.phplaravel-snappy 的配置文件,用于配置导出 pdf 的选项。, (*8)

      pdf.binary 项配置 wkhtmltopdf 执行文件的目录, (*9)

      linux/unix/mac 系统的执行文件存放于 项目目录/vendor/h4cc/wkhtmltopdf-[amd64|i386]/bin/ 目录下, (*10)

      wundiws 系统的执行文件存放于 项目目录/vendor/wemersonjanuario/wkhtmltopdf-windows/bin/[64bit|32bit]/ 目录下, (*11)

使用

安装扩展后,浏览器访问 [http|https]://[your domain or ip]/ddoc, (*12)

参考问题

  1. Q:导出的 PDF 文件中文不显示或者乱码?, (*13)

    A:导致此问题的原因是机器上没有安装中文字体,解决方式如下, (*14)

    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
    

参考图

, (*15)

, (*16)

, (*17)

, (*18)

, (*19)

License

The MIT License (MIT). Please see License File for more information., (*20)

The Versions

19/07 2018

dev-master

9999999-dev https://github.com/YunhanTech/laravel-ddoc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  Sources   Download

MIT

The Requires

 

The Development Requires

by RayGu

laravel yunhantech dbdoc

19/07 2018

v1.0.3

1.0.3.0 https://github.com/YunhanTech/laravel-ddoc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  Sources   Download

MIT

The Requires

 

The Development Requires

by RayGu

laravel yunhantech dbdoc

17/07 2018

v1.0.2

1.0.2.0 https://github.com/YunhanTech/laravel-ddoc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  Sources   Download

MIT

The Requires

 

The Development Requires

by RayGu

laravel yunhantech dbdoc

16/07 2018

v1.0.1

1.0.1.0 https://github.com/YunhanTech/laravel-ddoc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  Sources   Download

MIT

The Requires

 

The Development Requires

by RayGu

laravel yunhantech dbdoc

23/06 2018

v1.0.0

1.0.0.0 https://github.com/YunhanTech/laravel-ddoc

每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息并显示在网页上,支持导出Html和PDF文件。

  Sources   Download

MIT

The Requires

 

The Development Requires

by RayGu

laravel yunhantech dbdoc