mysql文档生成工具——mysql_markdown

说在前面的话~

mysql_markdown是一款基于GO语言命令行工具，他能生成数据库结构文档，生成的文件为.md（markdown）格式。我们可以通过Typora工具（一款好用的markdown编辑器）将md文件转成word，html，pdf等格式的文件。

先上效果

先说mysql_markdown的下载（我的是windows）：

拉取mysql_markdown的git项目到本地

git clone https://github.com/alicfeng/mysql_markdown.git

接下来就是编译mysql_markdown里的mysql_markdown.go文件，所以要安装go语言

GO安装地址：https://golang.org/dl/

一直下一步就好，而且GO不需要配置环境变量。

GO安装完成后，运行 go version看是否安装成功

C:\Users\Administrator>go version
go version go1.15.6 windows/amd64

确认安装成功后，切换到mysql_markdown目录下，执行build操作

cd mysql_markdown
go get "github.com/go-sql-driver/mysql"
go build .\mysql_markdown mysql_markdown.go

build（build就会在mysql_markdown目录下生成一个mysql_markdown.exe文件，即将go编译成了一个可执行文件）完后执行

mysql_markdown -h yourhost -u yourusername -p yourpwd -d yourdatabase -P yourport

结果如下：

红框框表示生成成功。在mysql_markdown文件夹下会生成对应数据库名的md文件。

在Typora打开刚生成的md文件，点击文件选项里的导出，选择你想要的格式导出就ok啦~

Typora下载地址：https://www.typora.io/#windows