BookStack项目中Mermaid图表渲染问题的解决方案
2025-05-13 03:47:01作者:农烁颖Land
在BookStack文档管理系统中,用户经常需要使用Mermaid图表来可视化数据。近期版本更新后,部分用户发现原本通过<pre>标签实现的Mermaid图表停止工作。本文将深入分析问题原因并提供专业解决方案。
问题背景
BookStack v25.02.1版本对代码编辑器进行了增强,导致系统会拦截所有<pre>标签的代码块。这影响了使用以下方式嵌入的Mermaid图表:
<pre class="mermaid">
pie title NETFLIX
"Time spent looking for movie" : 90
"Time spent watching it" : 10
</pre>
同时,用户尝试改用<div>标签的方案在WYSIWYG编辑器中也不奏效。
技术分析
问题的核心在于代码执行顺序和DOM处理机制:
- BookStack的代码处理逻辑会在Mermaid初始化之前执行
- 系统默认会处理所有
<pre>标签,无论其是否包含特殊类名 - 直接替换为
<div>标签的方案在WYSIWYG编辑器中无法正常工作
专业解决方案
推荐使用以下JavaScript代码作为自定义脚本解决方案:
<script src="https://cdn.jsdelivr.net/npm/mermaid@11.6.0/dist/mermaid.min.js"></script>
<script type="module">
mermaid.initialize({ startOnLoad: false });
const codeBlocks = document.querySelectorAll('.page-content pre.mermaid, .page-content pre code.language-mermaid');
const mermaidBlocks = [];
for (const codeBlock of codeBlocks) {
const mermaidBlock = document.createElement('div');
mermaidBlock.innerHTML = codeBlock.innerHTML;
mermaidBlocks.push(mermaidBlock);
const replaceTarget = (codeBlock.nodeName === 'CODE') ? codeBlock.parentElement : codeBlock;
replaceTarget.after(mermaidBlock);
replaceTarget.remove();
}
mermaid.run({
nodes: mermaidBlocks,
});
</script>
方案优势
- 提前执行:脚本在BookStack代码处理前运行,确保Mermaid图表不被拦截
- 兼容性强:支持两种Mermaid图表嵌入方式:
- 直接使用
<pre class="mermaid">标签 - 使用BookStack WYSIWYG编辑器创建的标准代码块(设置语言为mermaid)
- 直接使用
- 性能优化:批量处理所有Mermaid图表,减少DOM操作次数
实现原理
- 首先加载Mermaid库但不立即执行
- 查询页面中所有可能的Mermaid图表容器
- 创建新的
<div>元素来替代原始容器 - 将内容迁移到新容器后移除原始元素
- 最后调用Mermaid的渲染方法
注意事项
- 此方案需要添加到BookStack的自定义HTML头部区域
- 可能会与某些插件或自定义样式产生冲突,建议在测试环境先行验证
- 当BookStack版本更新时,应重新测试此方案的兼容性
通过此方案,用户可以继续在BookStack中无缝使用Mermaid图表功能,无论是简单的饼图还是复杂的关系图,都能得到完美呈现。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust099- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
项目优选
收起
deepin linux kernel
C
28
16
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
570
99
暂无描述
Dockerfile
709
4.51 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.61 K
942
Ascend Extension for PyTorch
Python
572
694
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
413
339
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.42 K
116
暂无简介
Dart
952
235
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
2