在 Markdown 文档中使用 plantuml

编程问答 2022-05-15

问题描述

目前我正在尝试使用 Markdown 进行演示。为了包含 UML 图，我想使用 PlantUML。代码写在下面的文档中。我的理解是，这应该有效。然而事实并非如此。当然，有一个解决方案可以单独在外部创建 UML 图并包含 in markdown。然而，这会使文档不那么自包含。有什么我遗漏的吗。

这是（部分）代码：

---
PrevIoUs slide

---

# diagram

```plantuml
@startuml
  class Example {
    - String name
    - int number 
    
    +void getName()
    +void getNumber()
    +String toString()
  }
@enduml
```

---
Next slide

---

This blog post 表明这应该有效。

解决方法

您链接到的文档并未说明 PlantUML 支持已内置于 Markdown 中，甚至未内置于 VSCode Markdown 插件中。它要求您安装扩展程序：

通过单个扩展，您可以在 VS Code 的预览面板中可视化 UML 图。

该扩展程序名为 plantuml，您可以通过在扩展程序面板中搜索它来安装它……或者只需从终端窗格中运行以下命令……

ext install plantuml

安装 plantuml 扩展，然后重试。

,

VSCode 扩展 Markdown-PDF 会将 Markdown 文件导出为 PDF 和 HTML。

该扩展支持 PlantUML 和 Mermaid。

检查扩展的页面以了解如何开始和结束 PlantUML 块，您不需要 ```

更多信息在这里： https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf

此外，自 2021 年 6 月起，VSCode 在 Markdown 中支持 KaTeX： https://code.visualstudio.com/updates/v1_58#_math-formula-rendering-in-the-markdown-preview

markdownplantumlvisual-studio-code