PHPackages                             ethan/laravel-ddoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. ethan/laravel-ddoc

ActiveLibrary

ethan/laravel-ddoc
==================

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

v1.1.5(4y ago)070MITPHPPHP ~5.6|~7.0|~8.0

Since Mar 31Pushed 4y agoCompare

[ Source](https://github.com/ethanfly/laravel-ddoc-fork)[ Packagist](https://packagist.org/packages/ethan/laravel-ddoc)[ Docs](https://github.com/ethan/laravel-ddoc)[ RSS](/packages/ethan-laravel-ddoc/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (6)Versions (17)Used By (0)

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

> 1. 导出 `Html` 实际为生成并导出一个离线版本的压缩包。
> 2. 导出 `PDF` 使用了 [laravel-snappy](https://github.com/barryvdh/laravel-snappy)扩展包
> 3. 导出 `Markdown` 为数据表增加了锚点链接。

安装
--

[](#安装)

1. 安装包文件

    ```
    $ composer require jormin/laravel-ddoc
    ```

配置
--

[](#配置)

1. 注册 ServiceProvider:

    ```
    Jormin\DDoc\DDocServiceProvider::class,
    ```
2. 创建配置文件：

    ```
    php artisan vendor:publish
    ```

    执行命令后会在 `config` 目录下生成两个文件：

    - `laravel-ddoc.php`：本扩展配置文件，用于配置文档底部 `Copyright` 文案和链接。
    - `snappy.php`：[laravel-snappy](https://github.com/barryvdh/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`

参考问题
----

[](#参考问题)

1. 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

    ```

参考图
---

[](#参考图)

[![](https://camo.githubusercontent.com/c8a555b5fdcf6d12357f3993d9c74ee294b676925a7cf6a3481bd4ccde05b1cb/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f38613036366134302d313631622d313165372d393263632d6539373865353739313032312e6a7067)](https://camo.githubusercontent.com/c8a555b5fdcf6d12357f3993d9c74ee294b676925a7cf6a3481bd4ccde05b1cb/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f38613036366134302d313631622d313165372d393263632d6539373865353739313032312e6a7067)

[![](https://camo.githubusercontent.com/3dcb13cc1e9c1b49f6f496c1b0f96eaa4fd3587014763591c93c5c0396550b95/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f39356262303064302d313631622d313165372d613835322d3966623936336531333431342e6a7067)](https://camo.githubusercontent.com/3dcb13cc1e9c1b49f6f496c1b0f96eaa4fd3587014763591c93c5c0396550b95/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f39356262303064302d313631622d313165372d613835322d3966623936336531333431342e6a7067)

[![](https://camo.githubusercontent.com/287cbce653234a2198e5ef8588a39439ecc9fd23a151211219fbaf7708e5d96f/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f61326431663733302d313631622d313165372d613130622d3435386531313339636231612e6a7067)](https://camo.githubusercontent.com/287cbce653234a2198e5ef8588a39439ecc9fd23a151211219fbaf7708e5d96f/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f61326431663733302d313631622d313165372d613130622d3435386531313339636231612e6a7067)

[![](https://camo.githubusercontent.com/4f240d85c744cd16404cce42dd8415728340ba4b3be25302627b430db6284a10/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f63643634333964302d313631622d313165372d383361652d3031626634396465366233652e6a7067)](https://camo.githubusercontent.com/4f240d85c744cd16404cce42dd8415728340ba4b3be25302627b430db6284a10/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f63643634333964302d313631622d313165372d383361652d3031626634396465366233652e6a7067)

[![](https://camo.githubusercontent.com/5e8d7301ad5dbad5e7c7a42ca5499944179ce380ba793f84378487885c7818b1/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f65666464383435302d336138372d313165382d386462382d6464633966613066623734342e6a7067)](https://camo.githubusercontent.com/5e8d7301ad5dbad5e7c7a42ca5499944179ce380ba793f84378487885c7818b1/68747470733a2f2f71696e69752e626c6f672e6c65727a656e2e636f6d2f65666464383435302d336138372d313165382d386462382d6464633966613066623734342e6a7067)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity76

Established project with proven stability

 Bus Factor1

Top contributor holds 90.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~107 days

Recently: every ~250 days

Total

16

Last Release

1719d ago

PHP version history (2 changes)v1.0PHP ~5.6|~7.0

v1.1.5PHP ~5.6|~7.0|~8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/811769cc774ffb95ae87505d801c501065d7bd9d2de797668ad1c202da411439?d=identicon)[ethanfly](/maintainers/ethanfly)

---

Top Contributors

[![jormin](https://avatars.githubusercontent.com/u/5519318?v=4)](https://github.com/jormin "jormin (58 commits)")[![ruchengtang](https://avatars.githubusercontent.com/u/1282479?v=4)](https://github.com/ruchengtang "ruchengtang (3 commits)")[![ethanflynoah](https://avatars.githubusercontent.com/u/190800793?v=4)](https://github.com/ethanflynoah "ethanflynoah (2 commits)")[![t5mx27dp](https://avatars.githubusercontent.com/u/189325049?v=4)](https://github.com/t5mx27dp "t5mx27dp (1 commits)")

---

Tags

laravelJorminDDoc

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/ethan-laravel-ddoc/health.svg)

```
[![Health](https://phpackages.com/badges/ethan-laravel-ddoc/health.svg)](https://phpackages.com/packages/ethan-laravel-ddoc)
```

###  Alternatives

[jormin/laravel-ddoc

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

1567.4k](/packages/jormin-laravel-ddoc)[zeeshanu/opus

Open source knowledge base application for Teams

1.2k2.0k](/packages/zeeshanu-opus)[jormin/laravel-geetest

极验验证码 v3.0 Laravel 扩展包

309.7k](/packages/jormin-laravel-geetest)[luketowers/oc-snappypdf-plugin

SnappyPDF integration for OctoberCMS

121.1k](/packages/luketowers-oc-snappypdf-plugin)[yajra/cms-core

Core module of YajraCMS.

201.8k1](/packages/yajra-cms-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
