这几天因为有一个项目要交付文档并且是一套在线可用的产品技术文档，所以需要个工具可以生成 markdown文件来供我们整合。试用了几款，还是下面要介绍的这款最方便实用，所以也推荐有需要的同学。

这是一个简单的小工具，可以根据数据库表结构生成数据库设计文档（格式包括markdown，html，word)，支持数据库（MySQL,Oracle,PostgreSQL)

首先下载工具：

链接: https://pan.baidu.com/s/1EsDfR3Fgfu7s7J-mbbvBNw 提取码: 6vke

解压后进入文件夹执行以下命令

windows 下执行 bin/start.bat

mac或linux 下执行 bin/start.sh （需设定执行权限 chmod 0755 bin/start.sh)

执行后就可以按提示进行文档生成操作了：

<pre language="typescript" code_block="true" style="caret-color: rgb(0, 0, 0); color: rgb(0, 0, 0); font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none;"></pre>

choose database:
1:mysql
2:oracle
3:PostgreSQL
Select the appropriate numbers choose database type
(Enter 'c' to cancel): 3
input database name:
boob-cms
input host:
localhost
input port:
5432
input username:
root
input password:
123456

输入完成后回车，即生成以名字为 ${dbname}-doc 格式的文件夹，我这里生成的是 boob-boc

├── README.md
├── bin
├── boob-doc
├── database.html
└── lib

文件夹中的文档就是以 markdown 文件来载体，

├── README.md
├── SUMMARY.md
├── article.md
├── boob.doc
├── boob.html
├── file.md
├── msg.md
├── notice.md
├── role.md
├── table.md
├── user.md
├── user_data.md
├── user_file.md
└── user_identity.md

生成出的 markdown 文件内容示例:

消息表(msg)

感觉非常好，后面有需要就可以用 gitbook 或者其他静态服务来生成一套完整的在文档了。