{"id":13471392,"url":"https://github.com/alicfeng/mysql_markdown","last_synced_at":"2025-04-05T09:06:56.400Z","repository":{"id":40614185,"uuid":"221527685","full_name":"alicfeng/mysql_markdown","owner":"alicfeng","description":"It can generate markdown structure documents of MySQL succinctly~","archived":false,"fork":false,"pushed_at":"2022-11-11T07:14:45.000Z","size":29274,"stargazers_count":438,"open_issues_count":3,"forks_count":93,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T08:06:41.079Z","etag":null,"topics":["document","markdown","mysql"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alicfeng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-13T18:40:49.000Z","updated_at":"2025-02-15T02:45:12.000Z","dependencies_parsed_at":"2022-07-14T04:00:38.049Z","dependency_job_id":null,"html_url":"https://github.com/alicfeng/mysql_markdown","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fmysql_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fmysql_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fmysql_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fmysql_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alicfeng","download_url":"https://codeload.github.com/alicfeng/mysql_markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312077,"owners_count":20918344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["document","markdown","mysql"],"created_at":"2024-07-31T16:00:44.265Z","updated_at":"2025-04-05T09:06:56.357Z","avatar_url":"https://github.com/alicfeng.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/alicfeng/mysql_markdown\"\u003e\n    mysql_markdown\n  \u003c/a\u003e\n\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  🛠 It can generate markdown structure documents of MySQL succinctly~\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/alicfeng/mysql_markdown/releases\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/release/alicfeng/mysql_markdown\" alt=\"release version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/alicfeng/mysql_markdown\"\u003e\n    \u003cimg src=\"https://travis-ci.org/alicfeng/mysql_markdown.svg?branch=master\" alt=\"build status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://lbesson.mit-license.org\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"open source\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n## 前言背景\n\n在实施软件工程的时候，当要将某一版本归档时，需要汇总的文档要求还是比较高的、各类文档齐全，包括项目架构、项目安装、接口等文档，而数据库表结构说明文档亦属于其一。记得很早之前想找一个可以导出 `MySQL` 数据库表结构说明文档的工具，生态上的这种工具是有的、只不过并没有一个使我比较满足的。当然、看个人所需，我需要一个可以导出 `markdown` 文档的。\n\n于是 `mysql_markdown` 就出现了、应用而生。它是一款基于 `go` 语言编写的一个命令行工具，适用于 `Linux`、`Mac`、`Windows`等平台。**那么它可以做什么？他只有一个功能、就是生成数据库表结构说明文档，格式为`markdown`**。\n\n\n\n## 🪤 快速安装\n\n\u003e 哪位老哥协助帮忙发布到包管理器更是方便了 感恩~\n\n到 [releases](https://github.com/alicfeng/mysql_markdown/releases) 页面下载运行，源码编译也行。\n\n\n\n## 🚀 快速使用\n\n```shell\n# 帮助\n➜  mysql_markdown -h\nflag needs an argument: -h\nUsage: mysql_markdown [options...]\n--help  This help text\n-h      host.     default 127.0.0.1\n-u      username. default root\n-p      password. default root\n-d      database. default mysql\n-P      port.     default 3306\n-c      charset.  default utf8\n-o      output.   default current location\n-t      tables.   default all table and support ',' separator for filter, every item can use regexp\n-l      language. default cn,support: cn,en\n\n# 使用\n➜ mysql_markdown -p samego -d samego\nconnecting to MySQL to export markdown document file.\n 100% |█████████████████████████████████████████████████████████████████████████████████████| (31/31, 70 it/s)\nconvert to document finished in mysql_20220429_101148.md\n```\n\n\n\n# 💾 文档快照\n\n![MySQL 表结构生成 Markdown 文档](https://upload-images.jianshu.io/upload_images/1678789-8050fa3687e575db.png)\n\n\n\n## 🏷 特别说明\n\n`markdown` 转其它类型的文档推荐使用 `typora` 工具 它支持如下转换格式\n\n- md2pdf\n- md2html\n- md2html(without styles)\n- md2word\n- md2rtf\n- md2openOffice\n- md2Epub\n- md2latex\n- md2MediaWiki\n- md2reStructureText\n- md2textile\n- md2OPML\n- md2png\n\n\n\n## License\n\nmysql_markdown is licensed under the [MIT License](https://raw.githubusercontent.com/alicfeng/mysql_markdown/master/LICENSE).\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falicfeng%2Fmysql_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falicfeng%2Fmysql_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falicfeng%2Fmysql_markdown/lists"}