Just-the-Docs 项目中 Mermaid 图表渲染问题的解决方案

在 Just-the-Docs 项目中使用 Mermaid 图表时，开发者可能会遇到一个常见的渲染问题：当尝试使用 Mermaid 的六边形(hexagon)形状时，系统会抛出 Liquid 语法错误。这个问题源于 Mermaid 和 Jekyll 的模板语法冲突。

问题根源分析

Mermaid 图表语法使用双花括号 {{ }} 来定义六边形节点，例如：

flowchart TD;
    id1{{This is the text in the box}}

然而，Jekyll 使用的 Liquid 模板引擎同样使用 {{ }} 作为变量插值的语法标记。当 Jekyll 处理 Markdown 文件时，它会先尝试解析这些花括号，导致 Mermaid 图表无法正确渲染，并显示"Syntax error in graph"的错误信息。

解决方案

解决这个冲突的方法是使用 Liquid 的 raw 标签包裹 Mermaid 代码块。raw 标签会告诉 Liquid 模板引擎跳过对其中内容的解析，从而保留原始的 Mermaid 语法。

正确的写法应该是：

```mermaid
{% raw %}
flowchart TD;
    id1{{This is the text in the box}}
{% endraw %}
```

深入理解

1. 处理顺序：Jekyll 会先处理 Liquid 模板语法，然后再将内容传递给 Mermaid 渲染。因此需要先保护 Mermaid 语法不被 Liquid 解析。

2. 适用场景：这个解决方案不仅适用于六边形节点，也适用于任何包含类似语法冲突的 Mermaid 图表类型。

3. 版本兼容性：此解决方案在 Mermaid 各个版本中都有效，包括 9.4.3 和 10.9.1 等版本。

最佳实践建议

1. 对于复杂的 Mermaid 图表，建议始终使用 raw 标签包裹，以避免潜在的语法冲突。

2. 在团队协作项目中，可以考虑将这一要求写入文档规范，确保所有贡献者都遵循相同的写法。

3. 如果项目中使用 Mermaid 图表较多，可以考虑创建自定义的 Jekyll 插件或修改配置来简化这一过程。

通过理解这一问题的本质并采用正确的解决方案，开发者可以充分利用 Mermaid 在 Just-the-Docs 项目中的强大图表功能，而不会受到语法冲突的困扰。