06_使用VsCode、MarkDown和PlantUml搭建文档总结工具

• 推荐阅读
• 安装清单
• 一、搭建工具
  • 1.Java
  • 2.VSCode
  • 3.VSCode 插件
  • 4.Graphviz
• 二、MarkDown 语法入门
• 三、Plantuml 入门

[toc]

推荐阅读

• 在 VSCode 使用 Markdown 绘制 UML 图 (opens new window)
• PlantUML 的安装与使用 (opens new window)

安装清单

一、搭建工具

1.Java

PlantUML 是使用 Java 开发的，需要 Java 运行时环境

2.VSCode

下载 VSCode 并安装

3.VSCode 插件

安装完 VSCode 之后，需要安装如下插件

3.1 Markdown Preview Enhanced

https://github.com/shd101wyy/vscode-markdown-preview-enhanced (opens new window)

3.2 markdownlint

https://github.com/DavidAnson/vscode-markdownlint (opens new window)

3.3 Markdown All in One

https://github.com/yzhang-gh/vscode-markdown (opens new window)

3.4 plantuml

（1）安装 Plantuml 插件

https://github.com/qjebbs/vscode-plantuml (opens new window)

（2）安装 plantuml.jar

https://github.com/plantuml/plantuml (opens new window)

然后配置 plantuml 环境变量

4.Graphviz

二、MarkDown 语法入门

三、Plantuml 入门

参见官网：https://plantuml.com/zh/ (opens new window)