使用VSCode编辑Markdown+PlantUml

vscode :https://code.visualstudio.com/

什么是markdown:

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

在vscode上安装MarkDown相关插件:

  • Markdown Preview Enhanced
  • Markdown All io One

什么是plantuml:

PlantUML是一个通用性很强的工具,可以快速、直接地创建各种图表。

使用 PlantUML,您可以创建结构良好的 UML 图表,包括但不限于以下内容:

序列图

用例图

类图

对象图

活动图

组件图

部署图

状态图

时序图

plantuml网站:

使用简单的文字描述画UML图的开源工具。

ubuntu安装plantuml相关插件:

1.sudo apt install graphviz.

2.安装java.

3.vscode上安装plantuml插件.

4.在https://plantuml.com/zh/download上面下载 plantuml_xxx.jar 相关文件,并在vscode设置上面查找markdown-preview-enhanced.plantumlJarPath,把plantuml_xxx.jar的路径设置上去.

在vscode上新建一个markdown文件,例如sequence.md,然后输入如下内容:

示例

以下是一个简单的示例,展示如何在 Markdown 文件中嵌入一个时序图:

示例文档

```plantuml

@startuml

Alice -> "Bob()" : Hello

"Bob()" -> "This is very\nlong" as Long

' You can also declare:

' "Bob()" -> Long as "This is very\nlong"

Long --> "Bob()" : ok

@enduml

```

然后点击窗口右上角的MarkDown Preview Enhanced按钮

可以显示如下效果:

相关推荐
tan180°3 小时前
Linux进程信号处理(26)
linux·c++·vscode·后端·信号处理
小阳睡不醒6 小时前
vim 练习题
linux·编辑器·vim
向宇it6 小时前
【unity游戏开发——编辑器扩展】使用EditorGUI的EditorGUILayout绘制工具类在自定义编辑器窗口绘制各种UI控件
开发语言·ui·unity·c#·编辑器·游戏引擎
和平宇宙6 小时前
vscode extention踩坑记
ide·vscode·编辑器
kooboo china.10 小时前
在UI 原型设计中,交互规则有哪些核心要素?
ui·编辑器·交互
慢一点会很快10 小时前
【Tools】VScode使用CMake构建项目
ide·vscode·编辑器
Mckay8813 小时前
android studio导入项目
android·ide·android studio
threelab13 小时前
05.three官方示例+编辑器+AI快速学习three.js webgl - animation - skinning - ik
人工智能·学习·编辑器
threelab13 小时前
04.three官方示例+编辑器+AI快速学习webgl_animation_skinning_additive_blending
人工智能·学习·编辑器