README.ja.md

English | 日本語

Rails Mermaid ERD

Ruby on Railsアプリケーションから Mermaid ERD を生成します。

デモページ

ERDは自由自在に生成できます。 生成されたERDはMarkdown形式でコピーできるため、GitHubなどで簡単に共有できます。 画像として保存することもできるので、Mermaidが使えない環境でも使えます。 エディターはシングルHTMLファイルであるため、エディター本体を共有することも可能です。

インストール手順

導入したいRailsアプリケーションのGemfileに以下の行を追加してください。

gem "rails-mermaid_erd", group: :development

次に、以下のコマンドを実行してGemをインストールします。

$ bundle install

使い方

Rakeタスク mermaid_erd を実行すると <app_root>/mermaid_erd/index.html が生成されます。

$ bundle exec rails mermaid_erd
# or
$ bundle exec rake mermaid_erd

生成された <app_root>/mermaid_erd/index.html をお使いのブラウザで開くだけです。 このファイルをGit管理から除外したい場合は .gitignore に以下の行を追加してください。

mermaid_erd

<app_root>/mermaid_erd/index.html はシングルHTMLファイルです。 このファイルを共有すれば、Ruby on Rails環境が無くても使用できます。サーバーにアップロードすれば、同じURLを共有することもできます。 CIと連携して生成から共有までを自動化するのはとても有効な手段です。

設定

./config/mermaid_erd.yml を設置することで設定を変更できます。 設定例は ./docs/example.yml を参照してください。

設定項目は次のとおりです。

キー	説明	初期値
result_path	生成されるファイルのパス。	mermaid_erd/index.html

ライセンス

The gem is available as open source under the terms of the MIT License.