puml-for-markdown 使用教程

项目介绍

puml-for-markdown 是一个命令行工具，用于在 GitHub Markdown 文件中嵌入交互式的 PlantUML 图表。这个工具的特点是无需构建文件，也不需要在本地安装 PlantUML，只需在包含 Markdown 文件的目录中运行该工具，即可渲染 Markdown 注释中的 PlantUML 文件链接。

项目快速启动

安装

首先，你需要全局安装 puml-for-markdown：

npm install -g puml-for-markdown

使用

在包含 Markdown 文件的目录中运行以下命令：

puml-for-markdown

这将自动渲染 Markdown 文件中的 PlantUML 链接。

应用案例和最佳实践

示例

假设你有一个 Markdown 文件 README.md，其中包含以下内容：

# 项目文档

## 系统架构

<!-- @startuml firstDiagram
Alice -> Bob: Hello
Bob -> Alice: Hi
@enduml -->

运行 puml-for-markdown 后，Markdown 文件将自动更新为：

# 项目文档

## 系统架构

<!-- @startuml firstDiagram
Alice -> Bob: Hello
Bob -> Alice: Hi
@enduml -->

[firstDiagram](https://www.plantuml.com/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000)

最佳实践

1. 使用独立的 PlantUML 文件：将复杂的 PlantUML 图表放在独立的文件中，然后在 Markdown 文件中引用这些文件。
2. 定期更新链接：如果更新了 PlantUML 文件，只需重新运行 puml-for-markdown 即可更新所有链接。

典型生态项目

C4-PlantUML

C4-PlantUML 是一个用于在 C4 模型中创建 PlantUML 图表的集合。它可以帮助你更方便地绘制系统上下文图、容器图、组件图等。

PlantUML

PlantUML 是一个开源项目，用于绘制 UML 图表。puml-for-markdown 依赖于 PlantUML 的在线服务来渲染图表。

通过这些工具和项目的结合使用，你可以更高效地在 Markdown 文档中嵌入和展示复杂的 UML 图表。