mirror of
https://github.com/usememos/memos.git
synced 2025-12-17 22:28:52 +08:00
feat(web): add Mermaid diagram support in markdown
Add support for rendering Mermaid diagrams in memo content using standard GFM/CommonMark syntax with fenced code blocks. Changes: - Add MermaidBlock component for rendering Mermaid diagrams - Update CodeBlock to detect and delegate mermaid language blocks - Use mermaid library (already in dependencies) for diagram rendering - Support standard syntax: ```mermaid...``` The implementation follows industry standards: - Uses fenced code blocks with 'mermaid' language identifier - Renders diagrams with error fallback to code display - Maintains security with strict mode rendering - Seamless integration with existing markdown pipeline Example usage: ```mermaid graph TD A[Start] --> B[Process] B --> C[End] ```
This commit is contained in:
parent
5925e3cfc1
commit
8259757800
2 changed files with 79 additions and 0 deletions
|
|
@ -1,6 +1,7 @@
|
||||||
import { CheckIcon, CopyIcon } from "lucide-react";
|
import { CheckIcon, CopyIcon } from "lucide-react";
|
||||||
import { useState } from "react";
|
import { useState } from "react";
|
||||||
import { cn } from "@/lib/utils";
|
import { cn } from "@/lib/utils";
|
||||||
|
import { MermaidBlock } from "./MermaidBlock";
|
||||||
|
|
||||||
interface PreProps {
|
interface PreProps {
|
||||||
children?: React.ReactNode;
|
children?: React.ReactNode;
|
||||||
|
|
@ -19,6 +20,15 @@ export const CodeBlock = ({ children, className, ...props }: PreProps) => {
|
||||||
const match = /language-(\w+)/.exec(codeClassName);
|
const match = /language-(\w+)/.exec(codeClassName);
|
||||||
const language = match ? match[1] : "";
|
const language = match ? match[1] : "";
|
||||||
|
|
||||||
|
// If it's a mermaid block, render with MermaidBlock component
|
||||||
|
if (language === "mermaid") {
|
||||||
|
return (
|
||||||
|
<MermaidBlock className={className} {...props}>
|
||||||
|
{children}
|
||||||
|
</MermaidBlock>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
const handleCopy = async () => {
|
const handleCopy = async () => {
|
||||||
try {
|
try {
|
||||||
await navigator.clipboard.writeText(codeContent);
|
await navigator.clipboard.writeText(codeContent);
|
||||||
|
|
|
||||||
69
web/src/components/MemoContent/MermaidBlock.tsx
Normal file
69
web/src/components/MemoContent/MermaidBlock.tsx
Normal file
|
|
@ -0,0 +1,69 @@
|
||||||
|
import mermaid from "mermaid";
|
||||||
|
import { useEffect, useRef, useState } from "react";
|
||||||
|
import { cn } from "@/lib/utils";
|
||||||
|
|
||||||
|
interface MermaidBlockProps {
|
||||||
|
children?: React.ReactNode;
|
||||||
|
className?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize mermaid with default configuration
|
||||||
|
mermaid.initialize({
|
||||||
|
startOnLoad: false,
|
||||||
|
theme: "default",
|
||||||
|
securityLevel: "strict",
|
||||||
|
fontFamily: "inherit",
|
||||||
|
});
|
||||||
|
|
||||||
|
export const MermaidBlock = ({ children, className }: MermaidBlockProps) => {
|
||||||
|
const containerRef = useRef<HTMLDivElement>(null);
|
||||||
|
const [svg, setSvg] = useState<string>("");
|
||||||
|
const [error, setError] = useState<string>("");
|
||||||
|
|
||||||
|
// Extract the code element and its content
|
||||||
|
const codeElement = children as React.ReactElement;
|
||||||
|
const codeContent = String(codeElement?.props?.children || "").replace(/\n$/, "");
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const renderDiagram = async () => {
|
||||||
|
if (!codeContent || !containerRef.current) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Generate a unique ID for this diagram
|
||||||
|
const id = `mermaid-${Math.random().toString(36).substring(7)}`;
|
||||||
|
|
||||||
|
// Render the mermaid diagram
|
||||||
|
const { svg: renderedSvg } = await mermaid.render(id, codeContent);
|
||||||
|
setSvg(renderedSvg);
|
||||||
|
setError("");
|
||||||
|
} catch (err) {
|
||||||
|
console.error("Failed to render mermaid diagram:", err);
|
||||||
|
setError(err instanceof Error ? err.message : "Failed to render diagram");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
renderDiagram();
|
||||||
|
}, [codeContent]);
|
||||||
|
|
||||||
|
// If there's an error, fall back to showing the code
|
||||||
|
if (error) {
|
||||||
|
return (
|
||||||
|
<div className="w-full">
|
||||||
|
<div className="text-sm text-destructive mb-2">Mermaid Error: {error}</div>
|
||||||
|
<pre className={className}>
|
||||||
|
<code className="language-mermaid">{codeContent}</code>
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
ref={containerRef}
|
||||||
|
className={cn("mermaid-diagram w-full flex justify-center items-center my-4 overflow-x-auto", className)}
|
||||||
|
dangerouslySetInnerHTML={{ __html: svg }}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
};
|
||||||
Loading…
Add table
Reference in a new issue