Usage

Configuration

Enable the Excalidraw panel on the issue page.

Excalidraw for Jira

Create a new drawing

Click Add New Drawing.

Excalidraw for Jira

Provide Drawing name, and draw some diagrams.

Excalidraw for Jira

Draw anything you want. To draw perfect shapes like a circle, hold the Shift button while drawing.

Excalidraw for Jira

Click Save and Close to save the drawing and go back to the issue.

The drawings are stored as an attachment named do-not-delete-excalidraw.json. This file should not be deleted or modified manually.

If you also want to export the drawing as an issue attachment, click Save and Attach Image. If the attachment does not appear, please refresh the issue page.

Excalidraw for JIra

Edit an existing drawing

To edit, click the thumbnail in the Excalidraw panel. Find the Edit button in the menu.

Excalidraw for Jira

Delete an existing drawing

Find the Delete button in the menu. At this moment the deletion is permanent.

Excalidraw for Jira

Adding new shapes from the Excalidraw Libraries website

The Excalidraw Libraries website (https://libraries.excalidraw.com) provides a lot of useful shapes. These shapes are contributed by the community.

To add new shapes, visit the website and click the Download button to save the collection you need to your computer. The downloaded library file's extension is .excalidrawlib.

Do not use the Add to Excalidraw button, as the library will not be added to the plugin-hosted Excalidraw Editor.

Excalidraw for Jira

Open the Excalidraw Editor in Jira, and upload the library file.

Excalidraw for Jira

Excalidraw for Jira

You can then drag and drop shapes into the canvas.

Excalidraw for Jira

Saving shapes as libraries

Let's say we want to save the following doughnut shape to reuse later. The first step is to select the whole shape.

Excalidraw for Jira

Add the selected shape to your library.

Excalidraw for Jira

To save your library locally (for the backup purpose, for example), click the Export button.

Excalidraw for Jira