Skip to content

AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.

fix(mermaid): preserve subgraph edge alignment across previews and exports

tianma-if3e8ae47d3f19
diff --git a/apps/web/src/components/MermaidCodeBlock.tsx b/apps/web/src/components/MermaidCodeBlock.tsx
index 9c453cc8..198d710a 100644
--- a/apps/web/src/components/MermaidCodeBlock.tsx
+++ b/apps/web/src/components/MermaidCodeBlock.tsx
@@ -6,33 +6,8 @@ import { MERMAID_THEME_PALETTES, useMermaidTheme } from "./ThemeProvider";
import { MermaidViewer } from "./MermaidViewer";
import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "@/components/ui/tooltip";
import { copyTextToClipboard } from "@/lib/clipboard";
-import { renderMermaidWithFallback } from "@/lib/mermaid-renderer";
-import { mermaidDisplayScale, scaleMermaidSvg } from "@/lib/mermaid-svg";
-import { getOfficialMermaidThemeVariables } from "@/lib/mermaid-theme";
-
-type MermaidModule = typeof import("mermaid")["default"];
-type BeautifulMermaidModule = typeof import("beautiful-mermaid");
-
-let mermaidModulePromise: Promise<MermaidModule> | null = null;
-let mermaidRenderSequence = 0;
-let beautifulMermaidModulePromise: Promise<BeautifulMermaidModule> | null = null;
-
-const loadMermaid = () => {
- if (!mermaidModulePromise) {
- mermaidModulePromise = import("mermaid").then(({ default: mermaid }) => {
- return mermaid;
- });
- }
-
- return mermaidModulePromise;
-};
-
-const loadBeautifulMermaid = () => {
- if (!beautifulMermaidModulePromise) {
- beautifulMermaidModulePromise = import("beautiful-mermaid");
- }
- return beautifulMermaidModulePromise;
-};
+import { renderThemedMermaidSvg } from "@/lib/mermaid-renderer";
+import { mermaidDisplayScale } from "@/lib/mermaid-svg";
export const MermaidCodeBlock = ({ editor, node }: NodeViewProps) => {
const { t } = useTranslation();
@@ -97,32 +72,11 @@ export const MermaidCodeBlock = ({ editor, node }: NodeViewProps) => {
setRenderState("loading");
const palette = MERMAID_THEME_PALETTES[mermaidTheme];
- const renderBeautiful = () => loadBeautifulMermaid()
- .then(({ renderMermaidSVG, THEMES }) => renderMermaidSVG(source, {
- ...THEMES[mermaidTheme],
- ...palette,
- transparent: true,
- font: "Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
- padding: 24,
- })).then(scaleMermaidSvg);
- const renderOfficial = () => loadMermaid().then(async (mermaid) => {
- mermaid.initialize({
- startOnLoad: false,
- securityLevel: "strict",
- suppressErrorRendering: true,
- theme: "base",
- themeVariables: getOfficialMermaidThemeVariables(palette),
- });
- const valid = await mermaid.parse(source, { suppressErrors: true });
- if (!valid) throw new Error("Invalid Mermaid diagram");
-
- mermaidRenderSequence += 1;
- const { svg: renderedSvg } = await mermaid.render(`edgeever-mermaid-${mermaidRenderSequence}`, source);
- return renderedSvg;
- });
- const renderPromise = renderMermaidWithFallback({
- renderBeautiful,
- renderOfficial,
+ const renderPromise = renderThemedMermaidSvg(source, {
+ theme: mermaidTheme,
+ palette,
+ font: "Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
+ padding: 24,
});
void renderPromise
diff --git a/apps/web/src/lib/mermaid-renderer.test.mjs b/apps/web/src/lib/mermaid-renderer.test.mjs
index fc3cd8c7..51d6ce15 100644
--- a/apps/web/src/lib/mermaid-renderer.test.mjs
+++ b/apps/web/src/lib/mermaid-renderer.test.mjs
@@ -9,6 +9,36 @@ const GANTT_SOURCE = `gantt
Compatibility fallback :fallback, 2026-07-30, 1d`;
describe("Mermaid renderer fallback", () => {
+ test("routes the reported subgraph to Mermaid even when the compact renderer would succeed", async () => {
+ const source = `flowchart LR
+ subgraph 日志开启建议
+ A[生产环境] -->|不开启| B[查询日志]
+ C[开发/测试/调试] -->|按需开启| B
+ E[审计场景] -->|按需开启| B
+ end`;
+ expect(renderMermaidSVG(source)).toContain("<svg");
+ let compactRenderCount = 0;
+ const svg = await renderMermaidWithFallback({
+ source,
+ renderBeautiful: () => {
+ compactRenderCount += 1;
+ return renderMermaidSVG(source);
+ },
+ renderOfficial: () => '<svg data-renderer="mermaid"></svg>',
+ });
+ expect(compactRenderCount).toBe(0);
+ expect(svg).toContain('data-renderer="mermaid"');
+ });
+
+ test("does not route a comment mentioning subgraphs to the official renderer", async () => {
+ const svg = await renderMermaidWithFallback({
+ source: "flowchart LR\n%% subgraph example\nA --> B",
+ renderBeautiful: () => '<svg data-renderer="beautiful"></svg>',
+ renderOfficial: () => { throw new Error("Unexpected official render"); },
+ });
+ expect(svg).toContain('data-renderer="beautiful"');
+ });
+
test("always uses the compact renderer when it supports the diagram", async () => {
let officialRenderCount = 0;
const svg = await renderMermaidWithFallback({
diff --git a/apps/web/src/lib/mermaid-renderer.ts b/apps/web/src/lib/mermaid-renderer.ts
index 5bcc5617..3c266bf6 100644
--- a/apps/web/src/lib/mermaid-renderer.ts
+++ b/apps/web/src/lib/mermaid-renderer.ts
@@ -1,15 +1,68 @@
+import type { MermaidThemeName, MermaidThemePalette } from "../components/ThemeProvider";
+import { scaleMermaidSvg } from "./mermaid-svg";
+import { getOfficialMermaidThemeVariables } from "./mermaid-theme";
+
interface MermaidRenderFallbackOptions {
+ source?: string;
renderBeautiful: () => string | Promise<string>;
renderOfficial: () => string | Promise<string>;
}
export const renderMermaidWithFallback = async ({
+ source = "",
renderBeautiful,
renderOfficial,
}: MermaidRenderFallbackOptions) => {
+ // The compact renderer offsets subgraph nodes without moving their edge endpoints.
+ // It can return a valid SVG with disconnected arrows, so exceptions are insufficient.
+ if (/^\s*subgraph\b/m.test(source)) return renderOfficial();
+
try {
return await renderBeautiful();
} catch {
return renderOfficial();
}
};
+
+let officialModule: Promise<typeof import("mermaid")["default"]> | undefined;
+let compactModule: Promise<typeof import("beautiful-mermaid")> | undefined;
+let officialQueue: Promise<unknown> = Promise.resolve();
+let renderSequence = 0;
+
+export const renderThemedMermaidSvg = (
+ source: string,
+ { theme, palette, font, padding }: {
+ theme: MermaidThemeName;
+ palette: MermaidThemePalette;
+ font: string;
+ padding: number;
+ },
+) => renderMermaidWithFallback({
+ source,
+ renderBeautiful: async () => {
+ const { renderMermaidSVG, THEMES } = await (compactModule ??= import("beautiful-mermaid"));
+ return scaleMermaidSvg(renderMermaidSVG(source, {
+ ...THEMES[theme], ...palette, transparent: true, font, padding,
+ }));
+ },
+ renderOfficial: () => {
+ // Mermaid configuration is global. Keep initialization and rendering together
+ // when several blocks or export jobs request different themes concurrently.
+ const result = officialQueue.then(async () => {
+ const mermaid = await (officialModule ??= import("mermaid").then(({ default: module }) => module));
+ mermaid.initialize({
+ startOnLoad: false,
+ securityLevel: "strict",
+ suppressErrorRendering: true,
+ theme: "base",
+ themeVariables: getOfficialMermaidThemeVariables(palette),
+ });
+ const valid = await mermaid.parse(source, { suppressErrors: true });
+ if (!valid) throw new Error("Invalid Mermaid diagram");
+ const { svg } = await mermaid.render(`edgeever-mermaid-${++renderSequence}`, source);
+ return svg;
+ });
+ officialQueue = result.catch(() => undefined);
+ return result;
+ },
+});
diff --git a/apps/web/src/lib/note-html-export.ts b/apps/web/src/lib/note-html-export.ts
index 040fc8cf..7cd15aba 100644
--- a/apps/web/src/lib/note-html-export.ts
+++ b/apps/web/src/lib/note-html-export.ts
@@ -1,7 +1,6 @@
import hljs from "highlight.js/lib/common";
-import { renderMermaidSVG, THEMES } from "beautiful-mermaid";
import { MERMAID_THEME_PALETTES } from "@/components/ThemeProvider";
-import { scaleMermaidSvg } from "@/lib/mermaid-svg";
+import { renderThemedMermaidSvg } from "@/lib/mermaid-renderer";
const WINDOWS_RESERVED_NAME = /^(con|prn|aux|nul|com[1-9]|lpt[1-9])(?:\.|$)/i;
const EXPORT_FONT_FAMILY =
@@ -188,13 +187,12 @@ export const renderMermaidBlocksForHtmlExport = async (root: HTMLElement) => {
}
try {
- const svg = scaleMermaidSvg(renderMermaidSVG(source, {
- ...THEMES["zinc-light"],
- ...MERMAID_THEME_PALETTES["zinc-light"],
- transparent: true,
+ const svg = await renderThemedMermaidSvg(source, {
+ theme: "zinc-light",
+ palette: MERMAID_THEME_PALETTES["zinc-light"],
font: EXPORT_FONT_FAMILY,
padding: 24,
- }));
+ });
const figure = document.createElement("figure");
figure.className = "edgeever-html-mermaid";
figure.innerHTML = svg;
diff --git a/apps/web/src/lib/phone-preview-mermaid.ts b/apps/web/src/lib/phone-preview-mermaid.ts
index fce25b5c..f9b4a6f6 100644
--- a/apps/web/src/lib/phone-preview-mermaid.ts
+++ b/apps/web/src/lib/phone-preview-mermaid.ts
@@ -1,6 +1,6 @@
import type { Editor } from "@tiptap/react";
import { MERMAID_THEME_PALETTES, type MermaidThemeName } from "@/components/ThemeProvider";
-import { scaleMermaidSvg } from "@/lib/mermaid-svg";
+import { renderThemedMermaidSvg } from "@/lib/mermaid-renderer";
const remapSvgIds = (svg: SVGElement, prefix: string) => {
const renamed = new Map<string, string>();
@@ -31,15 +31,13 @@ const remapSvgIds = (svg: SVGElement, prefix: string) => {
};
const renderMermaidSvg = async (source: string, theme: MermaidThemeName) => {
- const { renderMermaidSVG, THEMES } = await import("beautiful-mermaid");
const palette = MERMAID_THEME_PALETTES[theme] ?? MERMAID_THEME_PALETTES["zinc-light"];
- return scaleMermaidSvg(renderMermaidSVG(source, {
- ...THEMES[theme] ?? THEMES["zinc-light"],
- ...palette,
- transparent: true,
+ return renderThemedMermaidSvg(source, {
+ theme,
+ palette,
font: "Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
padding: 16,
- }));
+ });
};
export const embedMermaidForPreview = async (
diff --git a/apps/web/src/note-print.ts b/apps/web/src/note-print.ts
index 15753e41..e84e70c0 100644
--- a/apps/web/src/note-print.ts
+++ b/apps/web/src/note-print.ts
@@ -1,8 +1,7 @@
import { Previewer } from "pagedjs";
import hljs from "highlight.js/lib/common";
-import { renderMermaidSVG, THEMES } from "beautiful-mermaid";
import { MERMAID_THEME_PALETTES } from "@/components/ThemeProvider";
-import { scaleMermaidSvg } from "@/lib/mermaid-svg";
+import { renderThemedMermaidSvg } from "@/lib/mermaid-renderer";
import {
NOTE_PRINT_MESSAGE,
NOTE_PRINT_READY_MESSAGE,
@@ -49,13 +48,12 @@ const renderMermaidBlocks = async (root: HTMLElement, theme: MermaidThemeName, f
}
try {
- const svg = scaleMermaidSvg(renderMermaidSVG(source, {
- ...THEMES[theme] ?? THEMES["zinc-light"],
- ...palette,
- transparent: true,
+ const svg = await renderThemedMermaidSvg(source, {
+ theme,
+ palette,
font,
padding: 24,
- }));
+ });
const figure = document.createElement("figure");
figure.className = "edgeever-print-mermaid";
figure.innerHTML = svg;