summaryrefslogtreecommitdiffstats
path: root/dev-docs/docs/@excalidraw/mermaid-to-excalidraw/installation.mdx
blob: 1860fdf63fd64d475fa728a6ecccda44039ef819 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Installation

`@excalidraw/mermaid-to-excalidraw` is published to npm. This library is used in [excalidraw](https://excalidraw.com) 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](https://mermaid-to-excalidraw.vercel.app)