BookStack项目中Mermaid图表渲染问题的解决方案
2025-05-13 10:36:04作者:农烁颖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图表功能,无论是简单的饼图还是复杂的关系图,都能得到完美呈现。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C042
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0121
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
26
10
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
435
3.3 K
Ascend Extension for PyTorch
Python
241
277
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
694
367
仓颉编译器源码及 cjdb 调试工具。
C++
138
869
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
暂无简介
Dart
696
163
React Native鸿蒙化仓库
JavaScript
270
328
仓颉编程语言运行时与标准库。
Cangjie
145
881