Markdown Preview Enhanced を使わなくなった話

社内でシーケンス図などを資料として保存していく際には、 github でリポジトリを作り、 Markdown 形式でファイルを保存し、コード断片として PlantUML を埋め込んでいっている。 これまで、このファイルを閲覧するにあたり、 VSCode の Markdown Preview Enhanced を利用していたのだが、不便だったのでただの Markdown Preview に切り替えた話。

元々 Markdown Preview Enhanced を使っていた理由

普通に VSCode で入ってくる Markdown 拡張機能の Preview モードでも、 PlantUML の描写は可能といえば可能だった。 ただし、それには、予め立ち上がっている PlantUML サーバーの url を指定する必要があり、少し不便であった。

Markdown Preview Enhanced の場合、 plantuml のコマンドがありさえすれば、それを利用して PlantUML の図を描写することができたので、こっちをメインで使っていた。

移行を決意した理由

このプラグインは、イマイチ動作が安定しない。 突如、画面が真っ白になり、原因も不明、再インストールしても直らず、ネットで調べてもほとんど情報が見つからない、みたいな形になるのがしばしばであった。

ただのビューアーなので、安定して動作することが大事であり、かつ、プラグインのデバッグを自分でやるほどこれをどうにかしたい訳でもなかったので、もうちょっと安定している代替手段を探し始めた。

移行後の構成

ただの Markdown の拡張機能を用いて、かつ、 PlantUML サーバーは、 docker で立てておくことにした。 普段の作業端末は Mac だが、 Docker Desktop にはログイン時に起動アプリケーションとして自身を登録しておく機能がある。 それと、 docker container は run するときに、 restart policy を指定することができ、これにより docker が立ち上がった際に、同時に起動させたいコンテナも設定できる。 Docker は(開発)環境にデフォルトで入れるもの、としていくのであれば、これで良い、という個人的な結論を得た。