Repository files navigation

A command line tool for porting Excalidraw diagrams to Gliffy, draw.io and Mermaid.

Excalidraw is great for sketching diagrams as part of a design process, but chances are that you have to redo those sketches for documentation. This tool is made to bridge those tasks.

brew install excalidraw-converter

brew install sindrel/tap/excalidraw-converter

Download a compatible binary from theReleases page.

If you're a Linux or MacOS user, move it to your local bin folder to make it available in your environment (optional).

Convert your Excalidraw diagram by running:

exconv<command> -i<input-file>

See below for details on each command, available options and examples.

Converts to a Gliffy compatible format, which can be imported directly into services likeGliffy,Gliffy for Confluence,draw.io ordraw.io for Confluence.

Usage:

• Mac/Linux:

  exconv gliffy -i my-diagram.excalidraw

• Windows:

  exconv.exe gliffy -i C:\path\to\my-diagram.excalidraw

Flags:

  -h, --helphelpfor gliffy  -i, --input string    input file path  -o, --output string   output file path (default"your_file.gliffy")

After converting your diagram(s), import them into Gliffy (or draw.io) using the standard Import dialog. Mermaid diagrams can be pasted or included in markdown files or compatible tools.

Converts to aMermaid diagram that can be used for a variety of cases, such as being included in markdown fileson GitHub,GitLab,MkDocs orDocusaurus.

Usage:

• Mac/Linux:

  exconv mermaid -i my-diagram.excalidraw

• Windows:

  exconv.exe mermaid -i C:\path\to\my-diagram.excalidraw

Flags:

  -d, --direction string   flow direction'default','top-down','left-right','right-left' or'bottom-top' (default"top-down")  -h, --helphelpfor mermaid  -i, --input string       input file path  -o, --output string      output file path (default"your_file.mermaid")  -p, --print-to-stdout    print output to stdout instead of a file

You can validate and customize a converted diagram using tools likeMermaid Live Editor.

After converting your diagram(s), you can use theMermaid to Excalidraw playground to convert it back to the Excalidraw format.

Note that some styling attributes could be lost as part of the conversion and import process.

flowchart subgraph N0 [" "]  N4(("Hello!"))  N2{"Lorem Ipsum"}  subgraph N1 ["Example"]    N5("Sit Amet")    N3["Dolor"]  endendN2 --> N3N2 --> N5style N4 stroke:#e03131,stroke-width:2,fill:#ffffff,color:#e03131;style N5 stroke:#1e1e1e,fill:#ffc9c9,font-size:90%;style N3 stroke-dasharray: 2 2,stroke:#1e1e1e,stroke-width:2,fill:#ffec99,font-size:90%;style N2 stroke-dasharray: 5 5,stroke:#1e1e1e,fill:#b2f2bb,font-size:90%;style N0 stroke:#1e1e1e,stroke-width:2,fill:#a5d8ff;style N1 stroke:#1e1e1e,fill:#e7f5ff,font-size:90%;

All fixed shapes and most styling and text options are supported.

* Library graphics are not fully supported (experimental).

Converted Gliffy diagrams should also work in the online version ofdraw.io.

In draw.io, you can import a diagram by simply opening the file from your device. If you're using draw.io for Confluence, you should be able usethe import dialog.

Note that this isonly supported in the online version of draw.io, not the desktop app.

Diagrams created using theExcalidraw for Obsidian plugin must be exported before conversion, as describedhere.

See something you'd like to improve? Great! See thecontributing guidelines for instructions.

• Workflow icons created by Freepik - Flaticon

go mod download

gotest -v ./...

go run ./cmd/main.go<command><arguments>