MKDocでPlantUMLを使う
はじめに
最近Material for MKDocでドキュメントを書いています。
MKDocでPlantUMLを使いたいと思ったので、そのやり方を調べ、実際に試してみました。
方法
まず、以下のコマンドを実行し、plantumlを使えるようにする必要があります。
pip install plantuml-markdown
その後、mkdocs.ymlファイルに以下の記述を追加してください
markdown_extensions:
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
こうすることでMKDocsでPlantUMLが使えるようになります。
確認
試しに、以下の記述を書いてみます。
```plantuml
@startuml
Hello <|-- World
@enduml
```
結果は以下の通り。ちゃんと図が表示されています。（PlantUMLの節の部分です）
おわりに
MKDocでPlantUMLを使う方法を見ていきました
PlantUMLはテキストベースで書け変更管理が出来て便利なのでMKDocでもPlantUMLを活用していきたいと思います。
さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。
