在 VS Code 中本地配置 Markdown Preview Enhanced + PlantUML + Graphviz(dot)

【Linux 实战】在 VS Code 中本地配置 Markdown Preview Enhanced + PlantUML + Graphviz(dot)

适用场景:
✅ Linux 开发环境
✅ 技术文档 / 架构设计 / 流程图
✅ 企业内网 / 安全敏感环境(不走公网)
✅ Markdown 一体化预览 UML


一、背景与目标

在日常开发和技术分享中,我们经常需要在 Markdown 文档中绘制:

  • 时序图(Sequence Diagram)
  • 活动图(Activity Diagram)
  • 架构示意图

PlantUML + Markdown 是非常理想的组合。

但在 Linux + VS Code 环境下,常见问题包括:

  • VS Code 自带 Markdown Preview 不渲染 PlantUML
  • 使用在线 PlantUML Server 存在内容泄露风险
  • 本地渲染报错:plantuml.jar not found
  • 已安装 Graphviz,但 dot 不生效

本文将完整介绍如何在 Linux 下 配置:

✅ VS Code
✅ Markdown Preview Enhanced(MPE)
✅ 本地 PlantUML(jar)
✅ Graphviz(dot)
✅ 完全离线、无公网依赖的 UML 渲染方案


二、整体方案架构

VS Code
 └─ Markdown Preview Enhanced
      └─ Java
           └─ plantuml.jar
                └─ Graphviz (dot)

关键原则:

  • 不配置 plantumlServer
  • UML 内容只在本机渲染
  • 可断网使用
  • 符合企业信息安全规范

三、环境准备

1. 操作系统与工具

  • Linux(RHEL 等)
  • VS Code

2. Java(必需)

java -version

推荐版本:

  • ✅ Java 11 / Java 17(LTS)

示例(RHEL 系):

sudo dnf install java-17-openjdk

3. Graphviz(dot)

dot -V

未安装时:

sudo dnf install graphviz   # RHEL 系
sudo apt install graphviz   # Debian / Ubuntu

确认路径:

which dot

4. 下载 PlantUML(jar)

官方地址:

https://plantuml.com/download

建议路径:

/opt/plantuml/plantuml.jar

四、安装 VS Code 扩展

安装以下扩展:

  • Markdown Preview Enhanced

VS Code 内置 Markdown Preview 无法渲染 PlantUML


五、Linux 下打开 settings.json

方法 1:命令面板

Ctrl + Shift + P
> settings json
> Preferences: Open User Settings (JSON)

方法 2:直接打开文件(推荐)

code ~/.config/Code/User/settings.json

六、核心配置(本地 PlantUML + dot)

{
  "markdown-preview-enhanced.plantumlJarPath": "/opt/plantuml/plantuml.jar",
  "markdown-preview-enhanced.javaPath": "/usr/lib/jvm/java-17/bin/java",
  "markdown-preview-enhanced.plantumlGraphvizDotPath": "/usr/bin/dot",
  "markdown-preview-enhanced.enableScriptExecution": true
}

七、正确预览方式

✅ 右键 Markdown 文件 → Markdown Preview Enhanced: Open Preview to the Side

❌ 不使用 VS Code 内置 Markdown Preview


八、验证清单

  • ✅ UML 正常渲染
  • ✅ 断网可用
  • ✅ 无任何外部网络请求
  • ✅ 复杂图布局正常

十一、总结

该方案实现了:

  • Linux + VS Code 原生体验
  • Markdown + PlantUML 一体化
  • 完全本地渲染
  • 符合企业安全与合规要求

非常适合:

  • 架构设计文档
  • 测试/构建流程说明
  • 团队技术分享

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值