02.28 可以生成 markdown 格式的數據庫文檔生成工具

這幾天因為有一個項目要交付文檔並且是一套在線可用的產品技術文檔，所以需要個工具可以生成 markdown文件來供我們整合。試用了幾款，還是下面要介紹的這款最方便實用，所以也推薦有需要的同學。

這是一個簡單的小工具，可以根據數據庫表結構生成數據庫設計文檔（格式包括markdown，html，word)，支持數據庫（MySQL,Oracle,PostgreSQL)

首先下載工具：

<strong>鏈接: https://pan.baidu.com/s/1EsDfR3Fgfu7s7J-mbbvBNw 提取碼: 6vke

解壓後進入文件夾執行以下命令

<strong>windows 下執行 bin/start.bat

<strong>mac或linux 下執行 bin/start.sh （需設定執行權限 chmod 0755 bin/start.sh)

執行後就可以按提示進行文檔生成操作了：

<code>choose database:1:mysql2:oracle3:PostgreSQLSelect the appropriate numbers choose database type(Enter 'c' to cancel): 3input database name:boob-cmsinput host:localhostinput port:5432input username:rootinput password:123456/<code>

輸入完成後回車，即生成以名字為 ${dbname}-doc 格式的文件夾，我這裡生成的是 boob-boc

<code>.├── README.md├── bin├── boob-doc├── database.html└── lib/<code>

文件夾中的文檔就是以 markdown 文件來載體，

<code>.├── 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/<code>

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

<code># 消息表(msg)| 列名   | 類型   | KEY  | 可否為空 | 註釋   || ---- | ---- | ---- | ---- | ---- ||msgid|bigint(20)|PRI|否|主鍵ID||type|char(128)||是|類型||title|varchar(255)||是|標題||content|varchar(255)||是|詳情||read|smallint(6)||是|是否已讀||tuid|bigint(20)||是|接收人||suid|bigint(20)||是|觸發人||createtime|datetime||是|創建時間|/<code>

markdown 預覽

感覺非常好，後面有需要就可以用 gitbook 或者其他靜態服務來生成一套完整的在文檔了。

閱讀更多 劉佰晟 的文章

關鍵字: 生成 數據庫 Li