mysql_markdown
It can generate markdown structure documents of MySQL succinctly~
mysql_markdown
視頻鏈接：https://asciinema.org/a/68r0iwYLODOLVbAhHPExIjdo9
背景
在實(shí)施軟件工程的時(shí)候争便，當(dāng)要將某一版本歸檔時(shí)挥下，需要匯總的文檔要求還是比較高的筋夏、各類(lèi)文檔齊全，包括項(xiàng)目架構(gòu)秽梅、項(xiàng)目安裝、接口等文檔，而數(shù)據(jù)庫(kù)表結(jié)構(gòu)說(shuō)明文檔亦屬于其一巢寡。記得很早之前想找一個(gè)可以導(dǎo)出 MySQL 數(shù)據(jù)庫(kù)表結(jié)構(gòu)說(shuō)明文檔的工具，生態(tài)上的這種工具是有的椰苟、只不過(guò)并沒(méi)有一個(gè)使我比較滿足的抑月。當(dāng)然、看個(gè)人所需舆蝴，我需要一個(gè)可以導(dǎo)出 markdown 文檔的谦絮。
于是 mysql_markdown 就出現(xiàn)了、應(yīng)用而生洁仗。它是一款基于 go 語(yǔ)言編寫(xiě)的一個(gè)命令行工具层皱，適用于 Linux、Mac赠潦、Windows等平臺(tái)叫胖。那么它可以做什么？他只有一個(gè)功能她奥、就是生成數(shù)據(jù)庫(kù)表結(jié)構(gòu)說(shuō)明文檔瓮增，格式為madkdown。
安裝
unix
curl -o /usr/local/bin/mysql_markdown -sSL https://raw.githubusercontent.com/alicfeng/mysql_markdown/master/release/mysql_markdown_unix
chmod +x /usr/local/bin/mysql_markdown
mac
curl -o /usr/local/bin/mysql_markdown -sSL https://raw.githubusercontent.com/alicfeng/mysql_markdown/master/release/mysql_markdown_mac
chmod +x /usr/local/bin/mysql_markdown
other
git clone https://github.com/alicfeng/mysql_markdown.git
cd mysql_markdown
go get "github.com/go-sql-driver/mysql"
go build -o /usr/local/bin/mysql_markdown mysql_markdown.go
chmod +x /usr/local/bin/mysql_markdown
使用
# 幫助函數(shù)
? mysql_markdown -h
flag needs an argument: -h
Usage: mysql_markdown [options...]
--help This help text
-h host. default 127.0.0.1
-u username. default root
-p password. default root
-d database. default mysql
-P port. default 3306
-c charset. default utf8
-o output. default current location
# 簡(jiǎn)單使用
? mysql_markdown -p samego -d samego
mysql connected ...
1/8 the demo table is making ...
2/8 the failed_jobs table is making ...
3/8 the migrations table is making ...
4/8 the password_resets table is making ...
5/8 the roles table is making ...
6/8 the user table is making ...
7/8 the userinfo table is making ...
8/8 the users table is making ...
mysql_markdown finished ...
md2anyDoc
md轉(zhuǎn)其它類(lèi)型的文檔推薦使用 typora 工具 它支持如下轉(zhuǎn)換格式
- md2pdf
- md2html
- md2html(without styles)
- md2word
- md2rtf
- md2openOffice
- md2Epub
- md2latex
- md2MediaWiki
- md2reStructureText
- md2textile
- md2OPML
- md2png
文檔頁(yè)面效果
生成的MD文件
MySQL 表結(jié)構(gòu)生成 Markdown 文檔
MD文件轉(zhuǎn)PDF
MySQL 表結(jié)構(gòu)生成 Markdown轉(zhuǎn)PDF 文檔
