Virtual whiteboard for sketching hand-drawn like diagrams

#whiteboard #app #selfhosted #docker #excel #mindmap #braindump #data #storage

website: https://excalidraw.com

Ryan Di 913921631b fix contain dim change 6 月之前
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 年之前
.github 6e0ee89ee4 fix: usage of `node12 which is deprecated` (#8791) 8 月之前
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 年之前
dev-docs b479f3bd65 feat: add first-class support for CJK (#8530) 9 月之前
examples 0e02366dee wip 8 月之前
excalidraw-app 1c55160e3f debug both in app 7 月之前
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 年之前
packages 913921631b fix contain dim change 6 月之前
public ef9ea14a75 fix: remove manifest.json (#8783) 8 月之前
scripts 61623bbeba fix: Comic Shanns issues, new fonts structure (#8641) 9 月之前
.dockerignore 8d530cf102 fix: Docker build in CI (#8312) 11 月之前
.editorconfig 8dccc793ee add editorconfig (#1198) 5 年之前
.env.development 35f778a734 build: set PWA flag in dev to false (#8788) 8 月之前
.env.production df168a6883 fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) 8 月之前
.eslintignore 6959a363f0 feat: canvas search (#8438) 10 月之前
.eslintrc.json 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 年之前
.gitattributes c814917927 Add gitattributes (#2164) 4 年之前
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 年之前
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 年之前
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 年之前
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 年之前
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 年之前
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 年之前
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 年之前
Dockerfile 8d530cf102 fix: Docker build in CI (#8312) 11 月之前
LICENSE 6f33d72e35 Add MIT License (#176) 5 年之前
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 年之前
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 年之前
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 年之前
package.json 57cf577376 fix: cleanup scripts and support upto node 22 (#8794) 8 月之前
setupTests.ts e957c8e9ee feat: image cropping (#8613) 9 月之前
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 年之前
vercel.json 230d0edc44 feat: multiple fonts fallbacks (#8286) 1 年之前
vitest.config.mts a80cb5896a feat: self-hosting existing google fonts (#8540) 10 月之前
yarn.lock 9da26fb7e0 unify exports in a single place 7 月之前

README.md


<img alt="Excalidraw is released under the MIT license." src="https://img.shields.io/badge/license-MIT-blue.svg"  />

<img alt="npm downloads/month" src="https://img.shields.io/npm/dm/@excalidraw/excalidraw"  />

<img alt="PRs welcome!" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat"  />

<img alt="Chat on Discord" src="https://img.shields.io/discord/723672430744174682?color=738ad6&label=Chat%20on%20Discord&logo=discord&logoColor=ffffff&widge=false"/>

<img alt="Follow Excalidraw on Twitter" src="https://img.shields.io/twitter/follow/excalidraw.svg?label=follow+@excalidraw&style=social&logo=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

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

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