• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

mysql_markdown: MySQL数据库表结构快速导出成MarkDown文档

原作者: [db:作者] 来自: 网络 收藏 邀请

mysql_markdown

It can generate markdown structure documents of MySQL succinctly~

build status


背景

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

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

安装

releases download

使用

# 帮助函数➜  mysql_markdown -hflag needs an argument: -hUsage: 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 samegomysql 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文件

MySQL 表结构生成 Markdown 文档

MD文件转PDF

MySQL 表结构生成 Markdown转PDF 文档


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap