Skip to content

插件选项

markdown-it-mermaid-enhanced 的公开配置面刻意保持得比较小

MermaidItOptions

字段类型默认值说明
theme'auto' | 'default' | 'dark' | 'forest' | 'neutral' | 'base''auto'auto 跟随系统深色模式
renderEngine'mermaidjs' | 'excalidraw''mermaidjs'指定 wrapper 背后的渲染器
sketchbooleanfalse开启 Mermaid sketch 模式
fontFamilystring''标准字体覆盖
sketchFontstring''手绘字体覆盖,同时隐式开启 sketch
minHeightstring''插件级最小高度回退值
mermaidConfigRecord<string, unknown>{}透传给 Mermaid.js 的额外配置
excalidrawConfigMermaidToExcalidrawConfig{}透传给 Excalidraw 转换层的配置

MermaidToExcalidrawConfig

字段类型说明
startOnLoadboolean透传给转换层
flowchart.curve'linear' | 'basis'Flowchart 曲线
themeVariables.fontSizestring转换阶段使用的字号
maxEdgesnumber边数量上限
maxTextSizenumber文本体积上限

一个紧凑示例

ts
import MarkdownIt from 'markdown-it'
import markdownItMermaidEnhanced from 'markdown-it-mermaid-enhanced'

const markdown = new MarkdownIt().use(markdownItMermaidEnhanced, {
  theme: 'auto',
  renderEngine: 'mermaidjs',
  sketch: true,
  sketchFont: '"Excalifont"',
  minHeight: '160px',
})