📊

【2023年版】VSCodeでPlantUMLを単独・MarkDown埋め込みの両方で使えるようにする

2023/09/18に公開

はじめに

こういう人向け

  • Mac ユーザ
    • 筆者は Apple Silicon(M2) の MacBook Pro
  • VS Code を日常的に使う
  • 設計書を MarkDown で書くときに PlatUML でフローチャートも描く

インストール

Javaのインストール

brew cask install adoptopenjdk

Graphvizのインストール

brew cask install adoptopenjdk

VSCode の拡張機能

PlantUML

PlantUMLファイル(.pu)をプレビューするために必要

https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml

Markdown Preview Enhanced

MarkDownファイル(.md)をプレビューするために必要

https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced

設定

Markdown Preview Enhanced

Markdown Preview Enhanced の設定画面で plantuml.jar の在処のパスを設定する必要がある

v0.7.1 以降から必要になった設定のようだ

https://github.com/shd101wyy/vscode-markdown-preview-enhanced

動作確認

PlantUMLファイル(.pu)

こういった内容を書いて .pu 拡張子で保存する

test.pu
@startuml
:Hello world;
:This is defined on
several **lines**;
@enduml

プレビューで表示されるようになる

MarkDownファイル(.md)

test.md
# タイトル

## フローチャート

\```plantuml
:Hello world;
:This is defined on
several **lines**;
\```

プレビューで表示されるようになる

Discussion