okomestudio/org-excalidraw

Open, create, export, and display excalidraw in org mode

org-excalidraw.el is developed to create, open, export, and display excalidraw in org mode.

Requirements

To work as experted, the following requirements should be fullfiled.

Open Drawings

In order to open/edit excalidraw, you can:

1. Install an excalidraw app in Google Chrome
2. Make the excalidraw the default application to open files with .excalidraw extension
3. Use resource opener of your desktop environment to verify:
   • For Linux, run xdg-open /path/to/example.excaldiraw
   • For Mac, run open /path/to/example.excalidraw

Create Thumbnails

SVG thumbnails are created for exporting and displaying. In order to achieve this goal, one of the following softwares should be setuped correctly.

• [prefered] yuzutech/kroki-cli can be installed via binary, please setup according to the manual
• Timmmm/excalidraw_export can be installed via npm install -g excalidraw_export

Installation

You must download the code and require it manually.

;; add to load path
(add-to-list 'load-path "/path/to/org-excalidraw.el")

;; load
(require 'org-excalidraw)

or use use-package with quelpa enabled:

(use-package org-excalidraw
  :commands (org-excalidraw-create-drawing)
  :quelpa (org-excalidraw :repo 4honor/org-excalidraw :fetcher github))

(require 'org-excalidraw)

Usage

• Treat excalidraw link type in the same way org mode provides for other link types
• Command org-excalidraw-create-drawing can be used to creat a blank drawing

Thanks

The work is based on the following works:

• TobiasZawada/org-yt: Youtube links in org-mode for the display part
• wdavew/org-excalidraw provides the initial inspirations and the create/open part