All Projects → alicfeng → Mysql_markdown

alicfeng / Mysql_markdown

Licence: mit
It can generate markdown structure documents of MySQL succinctly~

Programming Languages

go
31211 projects - #10 most used programming language

Projects that are alternatives of or similar to Mysql markdown

Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+8406.61%)
Mutual labels:  doc, markdown
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-78.85%)
Mutual labels:  doc, markdown
Kodexplorer
A web based file manager,web IDE / browser based code editor
Stars: ✭ 5,490 (+2318.5%)
Mutual labels:  doc, markdown
Skills Summary
An documentation to improve oneself
Stars: ✭ 264 (+16.3%)
Mutual labels:  markdown, mysql
Wizard
Wizard是一款开源的文档管理工具,支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+663.44%)
Mutual labels:  doc, markdown
Tbls
tbls is a CI-Friendly tool for document a database, written in Go.
Stars: ✭ 940 (+314.1%)
Mutual labels:  markdown, mysql
Notes
📝 Migrated to(迁移至) https://github.com/Kuangcp/Note 当前仓库已经废弃, 对应的博客网站:
Stars: ✭ 33 (-85.46%)
Mutual labels:  markdown, mysql
Adoc
📄🖊轻松的的 API MD文档编写工具
Stars: ✭ 92 (-59.47%)
Mutual labels:  doc, markdown
Goreadme
Generate readme file from Go doc. Now available with Github actions!
Stars: ✭ 113 (-50.22%)
Mutual labels:  doc, markdown
Go Mygen
Quickly generate CURD and documentation for operating MYSQL.etc
Stars: ✭ 94 (-58.59%)
Mutual labels:  markdown, mysql
Vue Styleguidist
Created from react styleguidist for Vue Components with a living style guide
Stars: ✭ 2,133 (+839.65%)
Mutual labels:  doc, markdown
Md
Generate a Markdown Documentation for a SFC Vue Component. Contribute: https://gitlab.com/vuedoc/md#contribute
Stars: ✭ 131 (-42.29%)
Mutual labels:  doc, markdown
Metal
基于beego开发的网站,管理后台系统,包含功能:登录,用户管理,权限管理,多线程获取数据,定时任务,爬虫,markdown,七牛上传图片。
Stars: ✭ 165 (-27.31%)
Mutual labels:  markdown, mysql
Markdown
A Python implementation of John Gruber’s Markdown with Extension support.
Stars: ✭ 2,725 (+1100.44%)
Mutual labels:  markdown
Notadd
A microservice development architecture based on nest.js. —— 基于 Nest.js 的微服务开发架构。
Stars: ✭ 2,556 (+1025.99%)
Mutual labels:  mysql
Github Markdown Toc
Easy TOC creation for GitHub README.md
Stars: ✭ 2,734 (+1104.41%)
Mutual labels:  markdown
Manual56
MySQL 5.6 手册翻译
Stars: ✭ 222 (-2.2%)
Mutual labels:  mysql
Wisteria
Beautiful document tool for your project.
Stars: ✭ 226 (-0.44%)
Mutual labels:  markdown
Easy Tips
A little Tips in my Code Career with Go&PHP 🥳🥳🥳
Stars: ✭ 2,555 (+1025.55%)
Mutual labels:  mysql
Javainterview
java中高级基础指南
Stars: ✭ 222 (-2.2%)
Mutual labels:  mysql

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 文档

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].