Ask questions or hang out on our discord.gg/UexuTaE.
Go to excalidraw.com to start sketching.
Read the latest news and updates on our blog. A good start is to see all the updates of One Year of Excalidraw.
If you like the project, you can become a sponsor at Open Collective.
Last but not least, we're thankful to these companies for offering their services for free:
You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.
Choose line or arrow and click click click instead of drag.
You can easily create charts by copy pasting data from Excel or just plain comma separated text.
To translate Excalidraw into other languages, please visit our Crowdin page. To add a new language, open an issue so we can get things set up on our end first.
Translations will be available on the app if they exceed a certain threshold of completion (currently 85%).
In order to create a session manually, you just need to generate a link of this form:
https://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22}
https://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA
The first set of digits is the room. This is visible from the server that’s going to dispatch messages to everyone that knows this number.
The second set of digits is the encryption key. The Excalidraw server doesn’t know about it. This is what all the participants use to encrypt/decrypt the messages.
Find a growing list of libraries containing assets for your drawings at libraries.excalidraw.com.
Try out @excalidraw/excalidraw
. This package allows you to easily embed Excalidraw as a React component into your apps.
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You may need to sign in with GitHub and reload the page
- You can start coding instantly, and even send PRs from there!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
git clone https://github.com/excalidraw/excalidraw.git
yarn
yarn start
Now you can open http://localhost:3000 and start coding in your favorite code editor.
Command | Description |
---|---|
yarn |
Install the dependencies |
yarn start |
Run the project |
yarn fix |
Reformat all files with Prettier |
yarn test |
Run tests |
yarn test:update |
Update test snapshots |
yarn test:code |
Test for formatting with Prettier |
You can use docker-compose to work on Excalidraw locally if you don't want to setup a Node.js env.
docker-compose up --build -d
We publish a Docker image with the Excalidraw client at excalidraw/excalidraw. You can use it to self-host your own client under your own domain, on Kubernetes, AWS ECS, etc.
docker build -t excalidraw/excalidraw .
docker run --rm -dit --name excalidraw -p 5000:80 excalidraw/excalidraw:latest
The Docker image is free of analytics and other tracking libraries.
At the moment, self-hosting your own instance doesn't support sharing or collaboration features.
We are working towards providing a full-fledged solution for self-hosting your own Excalidraw.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
And the main source of inspiration for starting the project is the awesome Zwibbler app.