V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
AlicFeng
V2EX  ›  开源软件

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

  •  
  •   AlicFeng · 2021-12-31 14:09:22 +08:00 · 1050 次点击
    这是一个创建于 833 天前的主题,其中的信息可能已经有所发展或是发生改变。

    mysql_markdown

    It can generate markdown structure documents of MySQL succinctly~

    build status


    背景

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

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

    MySQL 表结构生成 Markdown 文档

    MD 文件转 PDF

    MySQL 表结构生成 Markdown 转 PDF 文档

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

    4 条回复    2022-04-06 16:47:26 +08:00
    darksheep9527
        1
    darksheep9527  
       2022-01-01 20:36:10 +08:00
    感谢,毕业设计写文档用的上
    AlicFeng
        2
    AlicFeng  
    OP
       2022-01-01 20:52:51 +08:00
    @darksheep9527 客气了😄价值源于技术、技术源于分享
    guisheng
        3
    guisheng  
       2022-04-06 16:31:26 +08:00
    win 不可用吗?我都已经源码编译了
    guisheng
        4
    guisheng  
       2022-04-06 16:47:26 +08:00
    @guisheng 好吧 可以了。。。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1181 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 23:49 · PVG 07:49 · LAX 16:49 · JFK 19:49
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.