1
0
mirror of https://github.com/excalidraw/excalidraw.git synced 2024-11-10 11:35:52 +01:00
Virtual whiteboard for sketching hand-drawn like diagrams
Go to file
2023-12-15 15:16:25 +01:00
.codesandbox chore: update required node version to 18 (#6837) 2023-07-31 23:47:41 +02:00
.github fix: update path of files in docs (#7428) 2023-12-12 14:28:34 +05:30
.husky build: temporarily disable pre-commit (#6132) 2023-01-19 13:50:42 +01:00
dev-docs fix: update path of files in docs (#7428) 2023-12-12 14:28:34 +05:30
excalidraw-app fix: follow-mode tweaks (#7443) 2023-12-15 15:16:25 +01:00
firebase-project fix: update storage.rules (#5020) 2022-04-17 22:47:00 +02:00
packages fix: follow-mode tweaks (#7443) 2023-12-15 15:16:25 +01:00
public fix: Icon size in manifest (#7073) 2023-10-03 11:07:02 +02:00
scripts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
.dockerignore build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
.editorconfig add editorconfig (#1198) 2020-04-03 19:19:01 +02:00
.env.development feat: text-to-diagram (#7325) 2023-11-25 21:11:03 +00:00
.env.production feat: text-to-diagram (#7325) 2023-11-25 21:11:03 +00:00
.eslintignore build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
.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 build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
.lintstagedrc.js Keep errors, elements and comments consistent (#2340) 2020-11-05 18:06:18 +01:00
.npmrc feat: color picker redesign (#6216) 2023-05-18 16:06:27 +02:00
.nvmrc chore: update required node version to 18 (#6837) 2023-07-31 23:47:41 +02: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
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
crowdin.yml build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
docker-compose.yml chore: Update action versions and docker build (#3065) 2021-02-20 14:28:33 +00:00
Dockerfile build: update to node 18 in docker (#6822) 2023-07-28 12:06:33 +05:30
LICENSE Add MIT License (#176) 2020-01-05 13:09:29 -08:00
package.json feat: move utils to utils package and make @excalidraw/utils a workspace (#7432) 2023-12-13 21:51:27 +05:30
README.md docs: add npm downloads rate badge to README.md file (#7127) 2023-11-01 13:27:57 +01:00
setupTests.ts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
tsconfig.json build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
vercel.json build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
vitest.config.mts build: decouple package deps and introduce yarn workspaces (#7415) 2023-12-12 11:32:51 +05:30
yarn.lock feat: move utils to utils package and make @excalidraw/utils a workspace (#7432) 2023-12-13 21:51:27 +05:30

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. npm downloads/month 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