使用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按钮

可以显示如下效果:

相关推荐
多加点辣也没关系2 小时前
Claude Code 安装与配置(详细教程)
ide·ai
Austin_YB5 小时前
VScode中配置Python环境
ide·vscode·python
今天也是爱大大的一天吖5 小时前
vscode迁移插件至cursor的三个法子
ide·vscode·编辑器·cursor
汤姆yu8 小时前
IDEA使用通义灵码做现有项目迭代开发保姆级教程
java·ide·intellij-idea·灵码
阴暗扭曲实习生9 小时前
135编辑器素材管理系统的技术架构
架构·编辑器
易水寒陈9 小时前
使用vscode开发stm32
ide·vscode·stm32
2501_915918419 小时前
有没有Xcode 替代方案?在快蝎 IDE 中完成 iOS 开发的过程
ide·vscode·ios·个人开发·xcode·swift·敏捷流程
温酒斟与你9 小时前
idea编辑器新版UI回归旧版
java·ide·intellij-idea
God__is__a__girl9 小时前
IntelliJ IDEA 启动失败问题解决记录
java·ide·intellij-idea
粤M温同学1 天前
Android Studio 中安装 CodeBuddy AI助手
android·ide·android studio