首页
/ BookStack项目中Mermaid图表渲染问题的解决方案

BookStack项目中Mermaid图表渲染问题的解决方案

2025-05-13 10:09:13作者:农烁颖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处理机制:

  1. BookStack的代码处理逻辑会在Mermaid初始化之前执行
  2. 系统默认会处理所有<pre>标签,无论其是否包含特殊类名
  3. 直接替换为<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>

方案优势

  1. 提前执行:脚本在BookStack代码处理前运行,确保Mermaid图表不被拦截
  2. 兼容性强:支持两种Mermaid图表嵌入方式:
    • 直接使用<pre class="mermaid">标签
    • 使用BookStack WYSIWYG编辑器创建的标准代码块(设置语言为mermaid)
  3. 性能优化:批量处理所有Mermaid图表,减少DOM操作次数

实现原理

  1. 首先加载Mermaid库但不立即执行
  2. 查询页面中所有可能的Mermaid图表容器
  3. 创建新的<div>元素来替代原始容器
  4. 将内容迁移到新容器后移除原始元素
  5. 最后调用Mermaid的渲染方法

注意事项

  1. 此方案需要添加到BookStack的自定义HTML头部区域
  2. 可能会与某些插件或自定义样式产生冲突,建议在测试环境先行验证
  3. 当BookStack版本更新时,应重新测试此方案的兼容性

通过此方案,用户可以继续在BookStack中无缝使用Mermaid图表功能,无论是简单的饼图还是复杂的关系图,都能得到完美呈现。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
532
406
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
120
207
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
397
37
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
44
3
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
54