Back to Excalidraw

Installation

dev-docs/docs/@excalidraw/mermaid-to-excalidraw/installation.mdx

0.18.11.0 KB
Original Source

Installation

@excalidraw/mermaid-to-excalidraw is published to npm. This library is used in excalidraw to transform mermaid syntax to Excalidraw diagrams.

Using npm

bash
npm install @excalidraw/mermaid-to-excalidraw

Using yarn

bash
yarn add @excalidraw/mermaid-to-excalidraw

Usage

Once the library is installed, its ready to use.

js
import { parseMermaidToExcalidraw } from "@excalidraw/mermaid-to-excalidraw";
import { convertToExcalidrawElements}  from "@excalidraw/excalidraw"

try {
  const { elements, files } = await parseMermaid(diagramDefinition, {
    fontSize: DEFAULT_FONT_SIZE,
  });
  // currently the elements returned from the parser are in a "skeleton" format
  // which we need to convert to fully qualified excalidraw elements first
  const excalidrawElements = convertToExcalidrawElements(elements);

  // Render elements and files on Excalidraw
} catch (e) {
  // Error handling
}

Playground

Try it out here