植物图（PlantUML）Markdown 插件安装与配置完全指南

植物图（PlantUML）Markdown 插件安装与配置完全指南

项目基础介绍与编程语言

植物图Markdown插件是为Python-Markdown设计的一个扩展，允许用户在Markdown文档中嵌入PlantUML代码，从而自动生成图像并插入到文档中。此项目使用Python为主要开发语言，并依赖于PlantUML进行图表示义的解析和渲染。

关键技术和框架

• Python-Markdown: 扩展基于Markdown解析库，将Markdown文本转换为HTML。
• PlantUML: 用于理解特定语法并生成图表的工具，支持多种图类型如类图、流程图等。
• 可选依赖: 根据配置，可能需要本地或远程PlantUML服务，以及Graphviz（若选择本地PlantUML）来帮助渲染图形。

安装与配置步骤

准备工作

1. Python环境: 确保你的系统上已安装Python 3.x版本。
2. pip: Python的包管理器。如果未安装，通过Python安装程序或命令行工具安装它。
3. Git: 如需从GitHub克隆代码，需安装Git。

安装步骤

全球安装插件

1. 打开终端或命令提示符。
2. 使用pip全局安装植物图Markdown插件。确保pip是最新的，可以使用pip install --upgrade pip命令更新pip。
3. 运行以下命令安装插件：

   pip install plantuml-markdown
   

使用本地PlantUML二进制文件（推荐）

1. 下载并安装PlantUML: 访问PlantUML官网下载适合您系统的版本，并安装。
2. 安装Graphviz: PlantUML部分功能需要Graphviz的支持，从Graphviz官网获取安装包并安装。
3. 配置环境路径: 确保plantuml.jar所在目录添加至系统的PATH，或者创建一个指向PlantUML jar文件的脚本（例如，在Linux下创建plantuml脚本并放置于/usr/local/bin/）。

配置插件

在需要使用该插件的Markdown项目里，可以通过以下方式进行配置：

• 如果你需要指定PlantUML服务器或设置其他高级选项，创建一个YAML配置文件（如config.yml），并在Markdown处理命令中指定此配置文件。

# 示例配置文件：config.yml
plantuml_markdown:
  server: ""
  insecure: False
  cachedir: "/tmp"
  # 更多配置项...

• 在命令行使用时，附加 -c config.yml 参数以应用配置。

使用示例

编辑您的Markdown文件，加入PlantUML代码块。例如：

::uml::
format="png"
Goofy -> MickeyMouse: calls
MickeyMouse <-- Goofy: responds
::end-uml::

渲染文档

运行以下命令将Markdown文档转换为HTML，确保插件被正确调用：

markdown_py -x plantuml_markdown yourfile.md -o yourfile.html

如果你之前设置了配置文件，则命令变为：

markdown_py -x plantuml_markdown -c config.yml yourfile.md -o yourfile.html

至此，您已成功安装并配置了PlantUML Markdown插件，能够愉快地在Markdown文档中绘制各种图表了。