feat(mdx): add mermaid diagram support

apps/site/components/MDX/CodeBox/index.tsx

@@ -1,4 +1,5 @@
 import { getLanguageDisplayName } from '@node-core/rehype-shiki';
+import Mermaid from '@node-core/ui-components/MDX/Mermaid';
 
 import CodeBox from '#site/components/Common/CodeBox';
 
@@ -8,6 +9,12 @@ const MDXCodeBox: FC<HTMLAttributes<HTMLElement>> = ({
   children: code,
   className,
 }) => {
+  // Mermaid diagrams arrive as `<pre class="mermaid">` (see rehype-mermaid),
+  // so we render them as diagrams instead of code boxes
+  if (className?.split(' ').includes('mermaid')) {
+    return <Mermaid>{String(code)}</Mermaid>;
+  }
+
   const matches = className?.match(/language-(?<language>[a-zA-Z]+)/);
   const language = matches?.groups?.language ?? '';
 

apps/site/components/MDX/Mermaid/index.tsx

@@ -0,0 +1,22 @@
+'use client';
+
+import Mermaid from '@node-core/ui-components/MDX/Mermaid';
+import { useTheme } from 'next-themes';
+
+import type { FC } from 'react';
+
+/**
+ * Site-level wrapper that maps the next-themes resolved theme onto the
+ * shared Mermaid component from @node-core/ui-components.
+ */
+const MermaidDiagram: FC<{ children: string }> = ({ children }) => {
+  const { resolvedTheme } = useTheme();
+
+  return (
+    <Mermaid theme={resolvedTheme === 'dark' ? 'dark' : 'light'}>
+      {children}
+    </Mermaid>
+  );
+};
+
+export default MermaidDiagram;

apps/site/mdx/plugins.mjs

@@ -4,6 +4,7 @@ import { shikiOptions } from '#platform/shiki.mjs';
 import rehypeShikiji from '@node-core/rehype-shiki/plugin';
 import remarkHeadings from '@vcarl/remark-headings';
 import rehypeAutolinkHeadings from 'rehype-autolink-headings';
+import rehypeMermaid from 'rehype-mermaid';
 import rehypeSlug from 'rehype-slug';
 import remarkGfm from 'remark-gfm';
 import readingTime from 'remark-reading-time';
@@ -21,6 +22,9 @@ export const rehypePlugins = [
   rehypeSlug,
   // Automatically add anchor links to headings (H1, ...)
   [rehypeAutolinkHeadings, { behavior: 'wrap' }],
+  // Transforms ```mermaid code blocks into renderable diagrams;
+  // must run before Shiki so they are not highlighted as plain code
+  [rehypeMermaid, { strategy: 'pre-mermaid' }],
   // Transforms sequential code elements into code tabs and
   // adds our syntax highlighter (Shikiji) to Codeboxes
   () => singletonShiki,

apps/site/package.json

@@ -54,6 +54,7 @@
     "react-dom": "^19.2.8",
     "reading-time": "~1.5.0",
     "rehype-autolink-headings": "~7.1.0",
+    "rehype-mermaid": "^3.0.0",
     "rehype-slug": "~6.0.0",
     "remark-gfm": "~4.0.1",
     "remark-reading-time": "~2.1.0",

packages/ui-components/package.json

@@ -50,6 +50,7 @@
   },
   "dependencies": {
     "@heroicons/react": "^2.2.0",
+    "@mermanjs/web": "^0.7.0",
     "@orama/orama": "^3.1.18",
     "@orama/ui": "^1.5.4",
     "@radix-ui/react-avatar": "^1.2.3",

packages/ui-components/src/MDX/Mermaid/index.module.css

@@ -0,0 +1,17 @@
+.mermaid {
+  display: flex;
+  justify-content: center;
+  margin: 1rem 0;
+}
+
+.mermaid svg {
+  max-width: 100%;
+  height: auto;
+}
+
+.fallback {
+  overflow-x: auto;
+  padding: 1rem;
+  border-radius: 0.5rem;
+  background: rgb(0 0 0 / 0.05);
+}

packages/ui-components/src/MDX/Mermaid/index.stories.tsx

@@ -0,0 +1,39 @@
+
+import type { Meta as MetaObj, StoryObj } from '@storybook/react-webpack5';
+import type { ComponentProps } from 'react';
+
+import Mermaid from './index';
+
+type Story = StoryObj<typeof Mermaid>;
+type Meta = MetaObj<typeof Mermaid>;
+
+const defaultArgs: ComponentProps<typeof Mermaid> = {
+  children: 'graph TD;\n  A[Start] --> B[Process];\n  B --> C[End];',
+};
+
+export const Flowchart: Story = {};
+
+export const SequenceDiagram: Story = {
+  args: {
+    children:
+      'sequenceDiagram\n  Alice->>Bob: Hello Bob\n  Bob-->>Alice: Hi Alice',
+  },
+};
+
+export const Dark: Story = {
+  args: {
+    theme: 'dark',
+  },
+};
+
+export const InvalidSource: Story = {
+  args: {
+    children: 'this is not a diagram',
+  },
+};
+
+export default {
+  title: 'MDX/Mermaid',
+  component: Mermaid,
+  args: defaultArgs,
+} as Meta;

packages/ui-components/src/MDX/Mermaid/index.tsx

@@ -0,0 +1,35 @@
+'use client';
+
+import type { FC } from 'react';
+
+import useMermaid from '../../hooks/useMermaid';
+
+import styles from './index.module.css';
+
+
+type MermaidProps = {
+  /** The Mermaid diagram source. */
+  children: string;
+  /** The host appearance used for the rendered diagram. */
+  theme?: 'light' | 'dark';
+};
+
+const Mermaid: FC<MermaidProps> = ({ children, theme = 'light' }) => {
+  const { containerRef, error } = useMermaid({
+    source: String(children),
+    theme,
+  });
+
+  if (error) {
+    // If the diagram source is invalid, fall back to showing the source
+    return (
+      <pre className={styles.fallback}>
+        <code>{children}</code>
+      </pre>
+    );
+  }
+
+  return <div ref={containerRef} className={styles.mermaid} />;
+};
+
+export default Mermaid;

packages/ui-components/src/hooks/__test__/useMermaid.test.jsx

@@ -0,0 +1,54 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import { render, screen, waitFor } from '@testing-library/react';
+
+import useMermaid from '../useMermaid';
+
+const fakeMermaidModule = {
+  initMerman: async () => ({}),
+  renderSvgToElement: (target, source) => {
+    target.innerHTML = `<svg data-diagram="${source}"></svg>`;
+  },
+};
+
+const TestComponent = ({ source, loader }) => {
+  const { containerRef, error } = useMermaid({ source, loader });
+
+  return (
+    <div data-testid="container">
+      {error ? 'error' : ''}
+      <div ref={containerRef} data-testid="diagram" />
+    </div>
+  );
+};
+
+await describe('useMermaid', async () => {
+  await it('renders the diagram through the injected loader', async () => {
+    render(
+      <TestComponent
+        source="graph TD; A-->B;"
+        loader={async () => fakeMermaidModule}
+      />
+    );
+
+    await waitFor(() =>
+      assert.ok(
+        screen.getByTestId('diagram').innerHTML.includes('<svg'),
+        'expected the diagram SVG to be rendered'
+      )
+    );
+  });
+
+  await it('surfaces loader failures as an error state', async () => {
+    const failingLoader = async () => {
+      throw new Error('wasm failed to load');
+    };
+
+    render(<TestComponent source="graph TD; A-->B;" loader={failingLoader} />);
+
+    await waitFor(() =>
+      assert.ok(screen.getByTestId('container').textContent.includes('error'))
+    );
+  });
+});

packages/ui-components/src/hooks/useMermaid.ts

@@ -0,0 +1,63 @@
+'use client';
+
+import { useEffect, useRef, useState } from 'react';
+
+type MermaidModule = typeof import('@mermanjs/web');
+
+type UseMermaidOptions = {
+  /** The Mermaid diagram source. */
+  source: string;
+  /** The host appearance used for the rendered diagram. */
+  theme?: 'light' | 'dark';
+  /** Injectable module loader, so unit tests can stub the WASM renderer. */
+  loader?: () => Promise<MermaidModule>;
+};
+
+const defaultLoader: () => Promise<MermaidModule> = () =>
+  import('@mermanjs/web');
+
+/**
+ * Renders a Mermaid diagram through the Merman WASM renderer into the
+ * returned container ref. Rendering happens lazily on the client, so the
+ * WASM module is only loaded when a diagram is actually on the page.
+ */
+export const useMermaid = ({
+  source,
+  theme = 'light',
+  loader = defaultLoader,
+}: UseMermaidOptions) => {
+  const containerRef = useRef<HTMLDivElement>(null);
+  const [error, setError] = useState<Error | null>(null);
+
+  useEffect(() => {
+    let cancelled = false;
+
+    const renderDiagram = async () => {
+      try {
+        const merman = await loader();
+        await merman.initMerman();
+
+        if (!cancelled && containerRef.current) {
+          merman.renderSvgToElement(containerRef.current, source.trim(), {
+            host_theme: { appearance: theme },
+          });
+          setError(null);
+        }
+      } catch (renderError) {
+        if (!cancelled) {
+          setError(renderError as Error);
+        }
+      }
+    };
+
+    renderDiagram();
+
+    return () => {
+      cancelled = true;
+    };
+  }, [source, theme, loader]);
+
+  return { containerRef, error };
+};
+
+export default useMermaid;