mysql_markdown

It can generate markdown structure documents of MySQL succinctly~

背景

在实施软件工程的时候，当要将某一版本归档时，需要汇总的文档要求还是比较高的、各类文档齐全，包括项目架构、项目安装、接口等文档，而数据库表结构说明文档亦属于其一。记得很早之前想找一个可以导出 MySQL 数据库表结构说明文档的工具，生态上的这种工具是有的、只不过并没有一个使我比较满足的。当然、看个人所需，我需要一个可以导出 markdown 文档的。

于是 mysql_markdown 就出现了、应用而生。它是一款基于 go 语言编写的一个命令行工具，适用于 Linux、Mac、Windows等平台。**那么它可以做什么？他只有一个功能、就是生成数据库表结构说明文档，格式为markdown**。

安装

releases download

使用

# 帮助函数
➜  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
-t      tables.   default all table and support ',' separator for filter, every item can use regexp

# 简单使用
➜ 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 转其它类型的文档推荐使用 typora 工具它支持如下转换格式

md2pdf
md2html
md2html(without styles)
md2word
md2rtf
md2openOffice
md2Epub
md2latex
md2MediaWiki
md2reStructureText
md2textile
md2OPML
md2png

文档页面效果

生成的 MD 文件

MD 文件转 PDF

人工智能视觉算法数据标注 AI 时间量子领航数据 SameGo

MySQL 表结构生成 Markdown 文档 | 工具篇

mysql_markdown

背景

安装

使用

md2anyDoc

文档页面效果

生成的 MD 文件

MD 文件转 PDF