Virtual whiteboard for sketching hand-drawn like diagrams
Go to file
David Luzar 20edddcd4e
fix: ensure export preview is centered (#6337)
2023-03-14 13:03:55 +01:00
.codesandbox chore: update CodeSandbox links and add a config (#5624) 2022-08-29 18:52:04 +05:30
.github build: move release scripts to use release branch (#5958) 2022-12-06 16:33:02 +05:30
.husky build: temporarily disable pre-commit (#6132) 2023-01-19 13:50:42 +01:00
dev-docs fix: show error message when measureText API breaks in brave (#6336) 2023-03-13 19:46:09 +05:30
firebase-project fix: update `storage.rules` (#5020) 2022-04-17 22:47:00 +02:00
public fix: declare css variable for font in excalidraw so its available in host (#6160) 2023-01-25 15:44:20 +05:30
scripts feat: add thai lang support (#6314) 2023-03-11 22:15:52 +01:00
src fix: ensure export preview is centered (#6337) 2023-03-14 13:03:55 +01:00
.dockerignore build: stops ignoring .env files from docker context so env variables get set during react app build. (#5809) 2022-11-07 16:48:38 +05:30
.editorconfig add editorconfig (#1198) 2020-04-03 19:19:01 +02:00
.env.development chore: Add debug flag to enable text container bounding box (#6296) 2023-03-03 18:01:55 +05:30
.env.production feat: go-to-excalidrawplus button (#5202) 2022-05-18 18:30:34 +02:00
.eslintignore feat: image support (#4011) 2021-10-21 22:05:48 +02:00
.eslintrc.json chore: Update Typescript to 4.4.4 (#4188) 2021-11-02 14:24:16 +02:00
.gitattributes Add gitattributes (#2164) 2020-09-15 21:59:00 +02:00
.gitignore fix: show error message when measureText API breaks in brave (#6336) 2023-03-13 19:46:09 +05:30
.lintstagedrc.js Keep errors, elements and comments consistent (#2340) 2020-11-05 18:06:18 +01:00
.npmrc Add npmrc to have pinned deps (#727) 2020-02-07 13:59:23 +01:00
.nvmrc Chore: Update .nvmrc to match package.json engines definition (#3148) 2021-03-01 13:22:20 +01:00
.prettierignore Change target branch of coverage and pretty print (#1850) 2020-07-01 12:05:21 +03:00
.watchmanconfig Don't reset cache while zooming using a gesture (#1103) 2020-03-28 16:59:36 -07:00
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) 2020-10-13 14:47:07 +02:00
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
Dockerfile fix: docker build architecture:linux/amd64 error occur on linux/arm64 instance (#6197) 2023-02-07 11:44:31 +05:30
LICENSE Add MIT License (#176) 2020-01-05 13:09:29 -08:00
README.md docs: Fix outdated link in README.md (#6263) 2023-02-20 09:44:25 +00:00
crowdin.yml Locale 2020-03-19 20:38:52 +02:00
docker-compose.yml chore: Update action versions and docker build (#3065) 2021-02-20 14:28:33 +00:00
package.json fix: make tunnels work in multi-instance scenarios (#6178) 2023-02-01 10:46:17 +05:30
tsconfig-types.json chore: bump typescript@4.5.2 (#4283) 2021-11-19 19:51:28 +01:00
tsconfig.json chore: bump typescript@4.5.2 (#4283) 2021-11-19 19:51:28 +01:00
vercel.json feat: redirect vscode.excalidraw.com to vscode marketplace (#5285) 2022-06-23 17:42:50 +02:00
yarn.lock fix: make tunnels work in multi-instance scenarios (#6178) 2023-02-01 10:46:17 +05:30

README.md

Excalidraw

Excalidraw Editor | Blog | Documentation | Excalidraw+

An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.


Excalidraw is released under the MIT license. PRs welcome! Chat on Discord Follow Excalidraw on Twitter

Product showcase

Create beautiful hand-drawn like diagrams, wireframes, or whatever you like.

Features

The Excalidraw editor (npm package) supports:

  • 💯 Free & open-source.
  • 🎨 Infinite, canvas-based whiteboard.
  • ✍️ Hand-drawn like style.
  • 🌓 Dark mode.
  • 🏗️ Customizable.
  • 📷 Image support.
  • 😀 Shape libraries support.
  • 👅 Localization (i18n) support.
  • 🖼️ Export to PNG, SVG & clipboard.
  • 💾 Open format - export drawings as an .excalidraw json file.
  • ⚒️ Wide range of tools - rectangle, circle, diamond, arrow, line, free-draw, eraser...
  • ➡️ Arrow-binding & labeled arrows.
  • 🔙 Undo / Redo.
  • 🔍 Zoom and panning support.

Excalidraw.com

The app hosted at excalidraw.com is a minimal showcase of what you can build with Excalidraw. Its source code is part of this repository as well, and the app features:

  • 📡 PWA support (works offline).
  • 🤼 Real-time collaboration.
  • 🔒 End-to-end encryption.
  • 💾 Local-first support (autosaves to the browser).
  • 🔗 Shareable links (export to a readonly link you can share with others).

We'll be adding these features as drop-in plugins for the npm package in the future.

Quick start

Install the Excalidraw npm package:

npm install react react-dom @excalidraw/excalidraw

or via yarn

yarn add react react-dom @excalidraw/excalidraw

Don't forget to check out our Documentation!

Contributing

Integrations

Who's integrating Excalidraw

Google CloudMetaCodeSandboxObsidian ExcalidrawReplitSliteNotionHackerRank • and many others

Sponsors & support

If you like the project, you can become a sponsor at Open Collective or use Excalidraw+.

Thank you for supporting Excalidraw

Last but not least, we're thankful to these companies for offering their services for free:

Vercel Sentry Crowdin