15e019706d
Co-authored-by: dwelle <5153846+dwelle@users.noreply.github.com> |
6 months ago | |
|---|---|---|
| .codesandbox | 2 years ago | |
| .github | 7 months ago | |
| .husky | 2 years ago | |
| dev-docs | 6 months ago | |
| examples/excalidraw | 6 months ago | |
| excalidraw-app | 6 months ago | |
| firebase-project | 3 years ago | |
| packages | 6 months ago | |
| public | 6 months ago | |
| scripts | 6 months ago | |
| .dockerignore | 9 months ago | |
| .editorconfig | 5 years ago | |
| .env.development | 7 months ago | |
| .env.production | 7 months ago | |
| .eslintignore | 1 year ago | |
| .eslintrc.json | 9 months ago | |
| .gitattributes | 4 years ago | |
| .gitignore | 11 months ago | |
| .lintstagedrc.js | 4 years ago | |
| .npmrc | 2 years ago | |
| .nvmrc | 2 years ago | |
| .prettierignore | 5 years ago | |
| .watchmanconfig | 5 years ago | |
| CONTRIBUTING.md | 2 years ago | |
| Dockerfile | 9 months ago | |
| LICENSE | 5 years ago | |
| README.md | 1 year ago | |
| crowdin.yml | 1 year ago | |
| docker-compose.yml | 4 years ago | |
| package.json | 9 months ago | |
| setupTests.ts | 6 months ago | |
| tsconfig.json | 1 year ago | |
| vercel.json | 6 months ago | |
| vitest.config.mts | 6 months ago | |
| yarn.lock | 6 months ago | |
README.md
Excalidraw Editor | Blog | Documentation | Excalidraw+
An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.
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
.excalidrawjson 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
Note: following instructions are for installing the Excalidraw npm package when integrating Excalidraw into your own app. To run the repository locally for development, please refer to our Development Guide.
npm install react react-dom @excalidraw/excalidraw
or via yarn
yarn add react react-dom @excalidraw/excalidraw
Check out our documentation for more details!
Contributing
- Missing something or found a bug? Report here.
- Want to contribute? Check out our contribution guide or let us know on Discord.
- Want to help with translations? See the translation guide.
Integrations
Who's integrating Excalidraw
Google Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank • 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:
