はじめに
Emacsで技術資料のMarkdownを編集していると、PlantUMLで生成したダイアグラムを挿入したくなるシーンが多々ある。
Visual Studio Codeは、MPEプラグインを導入することで埋め込みのPlantUML記法をサポートしている。ただし、埋め込み記法は、Viewerを選ぶのでMPEの方式も一長一短のように思う。
一方で、EmacsもVisual Studio Codeの後塵を排するわけもなく、Markdown Modeとchatuのコンビネーションで、シンプルかつ使い勝手の良いPlantUMLのダイアログの挿入手法を提供している。
必要パッケージ
- Markdown Mode
-
chatu
-
chatuが
plantuml-jar-pathを使用するので、Emacsの初期化ファイルなどで定義が必要。-
例
macOSにmacportsでplantumlをインストールした場合の指定例を以下に示す。
(setq plantuml-jar-path "/opt/local/share/java/plantuml/plantuml.jar")
-
-
各パッケージの設定については、それぞれのオフィシャル・サイトを確認されたい。
使用方法
以下の全ての操作は、Emacs上で行う。
-
chatu-new関数のコール(デフォルトのキーバインドなし)
Markdown Modeで編集中のファイルにchatu専用のコメントを挿入して保存。保存を忘れると、chatuで生成したダイアグラムが想定外のところに挿入されてしまう可能性がある。
-
chatu-open関数のコール(
C-c C-o)
関数コールで新たに開いた外部PlantUMLファイルを編集して保存。 -
1.のMardownファイルのバッファに移動
-
chatu-add関数のコール(
C-c C-c C-c)
1.のコメント上で、chatu-add関数をコールすることで、chatuがコメントの直下にダイアグラムを挿入する。
注記
-
chatuのplantumlの生成モードはsvgのみをサポート
使用例
上記のpullreqを適用したchatuを使った使用例を以下に示す。
