PlantUML

约 1585 字大约 5 分钟

2025-03-01

概述

主题支持在文章中嵌入 PlantUML 图表。

该功能由 @vuepress/plugin-markdown-chart 提供支持。

配置

主题默认不启用该功能。

在 .vuepress/config.ts 配置文件中，启用该功能：

.vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'

export default defineUserConfig({
  theme: plumeTheme({
    markdown: {
      plantuml: true, 
    },
  }),
})

markdown.plantuml 的类型为 boolean | MarkdownItPlantumlOptions[]，传入数组时可以分别配置不同的图表类型。

默认通过公网服务器生成图形

plantuml 默认使用 https://www.plantuml.com/plantuml 这个公网服务器渲染图形，图表内容会被发送到该服务器。离线构建、内网部署或对内容外发有合规要求时，请改为自托管服务：

.vuepress/config.ts
export default defineUserConfig({
  theme: plumeTheme({
    markdown: {
      plantuml: [{ server: 'https://your-plantuml-server/' }],
    },
  }),
})