Заголовок:

mysql_markdown

Текст:

🛠 Это инструмент, который может быстро генерировать документы структуры MySQL в формате Markdown.

Введение и предыстория

При реализации программного обеспечения, когда необходимо заархивировать определённую версию, требования к сводным документам всё ещё относительно высоки, и требуются различные типы документов, включая документацию по архитектуре проекта, установке проекта, интерфейсам и т. д. Документация, описывающая структуру таблиц базы данных, также является важной частью. Я помню, что довольно давно хотел найти инструмент, который мог бы экспортировать документацию о структуре таблиц MySQL, и такие инструменты существуют в экосистеме, но ни один из них не удовлетворил меня полностью. Конечно, это зависит от индивидуальных потребностей, мне нужен инструмент, который может экспортировать документы в формате Markdown.

Так появился mysql_markdown, инструмент командной строки, написанный на языке Go и подходящий для платформ Linux, Mac и Windows. Что он может делать? У него есть только одна функция — генерировать документацию о структуре таблицы базы данных в формате Markdown.

🪤 Быстрая установка

Чтобы установить mysql_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

Лицензия

mysql_markdown лицензирован под MIT License.