データベースのテーブル定義書をつくるのは面倒ですので、既存のDBから、簡単に作りたいということで、

1. マークダウン作成（スクリプトからDBにアクセスして取得）
2. マークダウンを表示できない人のために、HTMLへ

で、作成する方法です。

わざわざGUIソフト等を入れて作るが面倒だと思い、とりあえずmarkdownで出力できないかどうか調べてたら、スクリプトを書いてくれてる方がたくさんいらっしゃったので、拝借し、ちょっと修正し、使わせていただきました。ありがとうございます。

Markdownで出力する

下記の方のコードを使わせていただきました。PHPです。 僕はローカルにanyenvでphpを入れてますが、バージョン等でエラーが出るかもしれないので、シンタックスエラーが出たら都度修正して下さい。 MySQLのテーブル定義をマークダウン（Qiita用）で出力する テーブル指定部分、僕のPHPバージョン的に、「[]」が使えない古いバージョンをよく使っているので（業務上）、少し改良しました。

37G: $table_names = explode(",", $argv[2]);

※第一引数に、「データベース名」、第二引数に「テーブル名」をカンマ区切りで。すべてのテーブルを指定する場合は「ALL」を指定します。

MarkdownからHTML出力

brewで「pandoc」を入れます。

brew install pandoc

HTMLに出力するのですが、CSSを適応したいと思います。今回は「github」のものを使います。

▶　gist.github.com

pandoc -c github.css input.md -o output.html

するとHTMLが作成されるので、他の人に渡すにも良いですね。

必要に応じてカラムの説明等は、HTMLを修正して、コメント欄に記述してあげれば完璧です。

まとめ

わざわざGUI等のソフトを入れずに、簡単に素早く、誰にでも閲覧できるような形でテーブル定義が作成できました。