Skip to content

主题配置

¥Theme Configuration

Mermaid 版本 8.7.0 中引入了动态和集成主题配置。

¥Dynamic and integrated theme configuration was introduced in Mermaid version 8.7.0.

现在可以在站点范围内或在单个 Mermaid 图上自定义主题。对于站点范围的主题定制,使用 initialize 调用。对于图特定的定制,使用 init 指令。

¥Themes can now be customized at the site-wide level, or on individual Mermaid diagrams. For site-wide theme customization, the initialize call is used. For diagram specific customization, the init directive is used.

可用主题

¥Available Themes

  1. default - 这是所有图表的默认主题。

    ¥default - This is the default theme for all diagrams.

  2. neutral - 该主题非常适合要打印的黑白文档。

    ¥neutral - This theme is great for black and white documents that will be printed.

  3. dark - 这个主题与深色元素或夜间模式很相配。

    ¥dark - This theme goes well with dark-colored elements or dark-mode.

  4. forest - 这个主题包含绿色阴影。

    ¥forest - This theme contains shades of green.

  5. base - 这是唯一可以修改的主题。使用此主题作为自定义的基础。

    ¥base - This is the only theme that can be modified. Use this theme as the base for customizations.

全站主题

¥Site-wide Theme

要在站点范围内自定义主题,请在 mermaid 上调用 initialize 方法。

¥To customize themes site-wide, call the initialize method on the mermaid.

initialize 调用设置 themebase 的示例:

¥Example of initialize call setting theme to base:

javascript
mermaid.initialize({
  securityLevel: 'loose',
  theme: 'base',
});

图表特定主题

¥Diagram-specific Themes

要自定义单个图表的主题,请使用 init 指令。

¥To customize the theme of an individual diagram, use the init directive.

theme 设置为 forestinit 指令示例:

¥Example of init directive setting the theme to forest:

提醒:唯一可以定制的主题是 base 主题。以下部分介绍如何使用 themeVariables 进行自定义。

¥Reminder: the only theme that can be customized is the base theme. The following section covers how to use themeVariables for customizations.

使用 themeVariables 自定义主题

¥Customizing Themes with themeVariables

要制作自定义主题,请通过 init 修改 themeVariables

¥To make a custom theme, modify themeVariables via init.

你将需要使用 base 主题,因为它是唯一可修改的主题。

¥You will need to use the base theme as it is the only modifiable theme.

参数描述类型属性
themeVariables可使用 init 指令修改目的primaryColorprimaryTextColorlineColor (查看完整列表)

使用 init 指令修改 themeVariables 的示例:

¥Example of modifying themeVariables using the init directive:

颜色和颜色计算

¥Color and Color Calculation

为了确保图表的可读性,某些变量的默认值是通过其他变量计算或导出的。例如,primaryBorderColor 是从 primaryColor 变量导出的。所以如果自定义了 primaryColor 变量,Mermaid 会自动调整 primaryBorderColor。调整可能意味着颜色反转、色调变化、变暗/变亮 10% 等。

¥To ensure diagram readability, the default value of certain variables is calculated or derived from other variables. For example, primaryBorderColor is derived from the primaryColor variable. So if the primaryColor variable is customized, Mermaid will adjust primaryBorderColor automatically. Adjustments can mean a color inversion, a hue change, a darkening/lightening by 10%, etc.

主题引擎只能识别十六进制颜色,不能识别颜色名称。因此,值 #ff0000 有效,但 red 无效。

¥The theming engine will only recognize hex colors and not color names. So, the value #ff0000 will work, but red will not.

主题变量

¥Theme Variables

变量默认值描述
darkModefalse影响派生颜色的计算方式。将值设置为 true 以实现夜间模式。
背景#f4f4f4用于计算应为背景色或与背景形成对比的项目的颜色
fontFamily投石机女士、verdana、arial
fontSize16px字体大小(以像素为单位)
primaryColor#fff4dd用作节点背景的颜色,其他颜色将从中派生
primaryTextColor根据 darkMode #ddd/#333 计算使用 primaryColor 用作节点中文本颜色的颜色
secondaryColor从原色计算
primaryBorderColor从原色计算使用 primaryColor 用作节点边框的颜色
secondaryBorderColor从 secondaryColor 计算使用 secondaryColor 用作节点边框的颜色
secondaryTextColor从 secondaryColor 计算使用 secondaryColor 用作节点中文本颜色的颜色
tertiaryColor从原色计算
tertiaryBorderColor从 tertiaryColor 计算使用 tertiaryColor 用作节点边框的颜色
tertiaryTextColor从 tertiaryColor 计算使用 tertiaryColor 用作节点中文本颜色的颜色
noteBkgColor#fff5ad在注意中用作背景的颜色
noteTextColor#333注释矩形中的文本颜色
noteBorderColor根据 noteBkgColor 计算注释矩形中的边框颜色
lineColor从背景计算
textColor从 primaryTextColor 计算图表中背景上的文本,例如时序图中标签和信号上的文本或甘特图中的标题
mainBkg从原色计算流程图对象的背景,如矩形/圆形、类图类、时序图等
errorBkgColortertiaryColor语法错误消息的颜色
errorTextColortertiaryTextColor语法错误消息的颜色

流程图变量

¥Flowchart Variables

变量默认值描述
nodeBorderprimaryBorderColor节点边框颜色
clusterBkgtertiaryColor子图中的背景
clusterBordertertiaryBorderColor簇边框颜色
defaultLinkColorlineColor链接颜色
titleColortertiaryTextColor标题颜色
edgeLabelBackground从 secondaryColor 计算
nodeTextColorprimaryTextColor节点内文本的颜色

时序图变量

¥Sequence Diagram Variables

变量默认值描述
actorBkgmainBkg角色背景颜色
actorBorderprimaryBorderColor角色边框颜色
角色文本颜色primaryTextColor角色文本颜色
角色线颜色actorBorder角色线颜色
signalColortextColor信号颜色
signalTextColortextColor信号文本颜色
labelBoxBkgColoractorBkg标签框背景颜色
labelBoxBorderColoractorBorder标签框边框颜色
labelTextColor角色文本颜色标签文本颜色
loopTextColor角色文本颜色循环文本颜色
激活边框颜色从 secondaryColor 计算激活边框颜色
激活 Bkg 颜色secondaryColor激活背景颜色
sequenceNumberColor根据 lineColor 计算序列号 颜色

饼图变量

¥Pie Diagram Variables

变量默认值描述
pie1primaryColor填写饼图中的第一部分
pie2secondaryColor填写饼图的第二部分
pie3从三级计算填写饼图中的第三部分
pie4从原色计算填写饼图中的第四部分
pie5从 secondaryColor 计算填写饼图中的第五部分
pie6从 tertiaryColor 计算填写饼图中的第 6 部分
pie7从原色计算填写饼图第七部分
pie8从原色计算填写饼图第 8 部分
pie9从原色计算填写饼图中的第 9 部分
pie10从原色计算填写饼图中的第 10 部分
pie11从原色计算填写饼图第 11 部分
pie12从原色计算填写饼图第 12 部分
pieTitleTextSize25px标题文本大小
pieTitleTextColortaskTextDarkColor标题文本颜色
pieSectionTextSize17px各个部分标签的文本大小
pieSectionTextColortextColor各个部分标签的文本颜色
pieLegendTextSize17px图表图例中标签的文本大小
pieLegendTextColortaskTextDarkColor图表图例中标签的文本颜色
pieStrokeColor黑色的各个饼图部分的边框颜色
pieStrokeWidth2px各个饼图部分的边框宽度
pieOuterStrokeWidth2px饼图外圆的边框宽度
pieOuterStrokeColor黑色的饼图外圆的边框颜色
pieOpacity0.7各个饼图部分的不透明度

状态颜色

¥State Colors

变量默认值描述
labelColorprimaryTextColor
altBackgroundtertiaryColor用于深度复合状态的背景

类别颜色

¥Class Colors

变量默认值描述
classTexttextColor类图中文本的颜色

用户旅程颜色

¥User Journey Colors

变量默认值描述
fillType0primaryColor填写旅程图中的第一部分
fillType1secondaryColor填写旅程图中的第二部分
fillType2从原色计算填写旅程图中的第三部分
fillType3从 secondaryColor 计算填写旅程图中的第四部分
fillType4从原色计算填写旅程图中的第五部分
fillType5从 secondaryColor 计算填写行程图中的第 6 部分
fillType6从原色计算填写旅程图第七部分
fillType7从 secondaryColor 计算填写旅程图第 8 部分