Markdown基础

Markdown是一种轻量级的标记语言，用于以简单的文本格式编写文档。它通过使用一系列符号（如 #、*、- 等）来标记文本的结构和样式，目的是使文本既易于编写，又能轻松转换成格式化后的HTML等格式。

为什么用markdown?

  1. 统一定义样式，省去了样式错乱的烦恼，在显示的时候被翻译成HTML显示，可以很清楚很好看。
  2. 用文本编辑的形式绘制流程图，时序图，类图等，提高绘图速度，降低更改成本
  3. 语法简洁易学，可读性强。
  4. Markdown是一种纯文本格式，适合于Git进行版本控制

1. 基本语法

https://markdown.com.cn/basic-syntax/

2. PlantUML的使用

PlantUML 是一个开源的工具，用于通过简单的文本描述来生成 UML（统一建模语言）图。它允许用户使用纯文本语法绘制各种类型的图表，如类图、时序图、用例图、状态图等。

https://plantuml.com/zh/

3. 利用vsCode编辑markdown文件

需要安装Markdown Preview Enhanced插件，它用于在编辑器中实时预览Markdown文件的内容，支持PDF和HTML导出、自定义主题等多种高级功能，广泛应用于开发者和写作者的工作流程中。

常见问题&解决办法

PC新装环境Markdown Preview Enhanced + planuml插件显示报错，提示plantuml.jar有问题。

{"errno":-4058,"code":"ENOENT","syscall":"spawn java","path":"java","spawnargs":["-Djava.awt.headless=true","-Dfile.encoding=UTF-8",
"-Dplantuml.include.path=e:\\MyWorkspace\\Project\\AutoTest\\YC_Chanjian_BCBslave\\FCT\\chunengdanxitong20240319","-jar",
"C:\\Program Files\\Java\\plantuml.jar","-pipe","-tsvg","-charset","UTF-8"]}

看起来在尝试运行Java命令时找不到Java可执行文件？

新环境需要安装JAVA环境以及plantuml.jar，安装后检查JAVA版本、环境变量，没有问题。

尝试配置插件Markdown-preview-enhanced: Plantuml Jar Path属性，没有效果。

尝试使用管理员模式打开，可以显示plantuml状态图

重新怀疑环境变量没有配置好，反复配置后无果，放弃。

尝试重启PC，重启后直接打开vscode即可预览Plantuml状态图。 可能是因为配置的环境变量没有生效？

results matching ""

    No results matching ""