Giter Site home page Giter Site logo

mysql_markdown's Introduction

🛠 It can generate markdown structure documents of MySQL succinctly~

release version build status open source

前言背景

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

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

🪤 快速安装

哪位老哥协助帮忙发布到包管理器更是方便了 感恩~

releases 页面下载运行,源码编译也行。

🚀 快速使用

# 帮助
➜  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
-l      language. default cn,support: cn,en

# 使用
➜ mysql_markdown -p samego -d samego
connecting to MySQL to export markdown document file.
 100% |█████████████████████████████████████████████████████████████████████████████████████| (31/31, 70 it/s)
convert to document finished in mysql_20220429_101148.md

💾 文档快照

MySQL 表结构生成 Markdown 文档

🏷 特别说明

markdown 转其它类型的文档推荐使用 typora 工具 它支持如下转换格式

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

License

mysql_markdown is licensed under the MIT License.

mysql_markdown's People

Contributors

alicfeng avatar linkstarter avatar lljiuzheyang avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mysql_markdown's Issues

Dockerfile增加ENTRYPOINT

FROM alpine:3.7
LABEL Maintainer="AlicFeng <[email protected]>" \
      Description="mysql_markdown based on golang"

COPY release/mysql_markdown_unix /usr/local/sbin/mysql_markdown

RUN chmod a+x /usr/local/sbin/mysql_markdown && \
    mkdir /data/

WORKDIR /data
ENTRYPOINT [ "/usr/local/sbin/mysql_markdown" ]
CMD [ "--help" ]

安装 (install)

我是 Mac 环境,不管我使用哪种安装方式,都会一直卡在某一个进度里面,导致我最终无法安装。我也尝试去 Google ,但是还是没有找到正确的答案。希望您能给予我帮助,下图是我分别使用两种安装方式遇到的情况及电脑系统版本信息。
image

Column排序问题

序号没有按照OrdinalPosition升序排序,unbuntu18.04下为乱序

突然不能执行了

/Users/kim/java/mysql_markdown_mac ; exit;  ✔  910  12:00:02
[1] 41222 killed /Users/kim/java/mysql_markdown_mac
Saving session...completed

~/java  ./mysql_markdown_mac --help  ✔  909  11:53:58
[1] 40456 killed ./mysql_markdown_mac --help

mysql_markdown_win

mysql_markdown_win.tar.gz 解压后 mysql_markdown_win 未携带扩展名 .exe
且 Windows 未原生支持 tar.gz 格式,需要额外下载解压软件,建议改用 zip 格式

闪退

win10 64 操作系统,运行下载的exe文件闪退

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.