You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jfinn 5f50266cde auto commit пре 3 година
.github chore: Update docker action to v2 (#4198) пре 3 година
.husky chore(deps-dev): Upgrade commit hooks to Husky 7 (#4116) пре 3 година
firebase-project feat: support exporting json to excalidraw plus (#3678) пре 3 година
public auto commit пре 3 година
scripts chore: Update translations from Crowdin (#4150) пре 3 година
src auto commit пре 3 година
.dockerignore chore: Update action versions and docker build (#3065) пре 4 година
.editorconfig add editorconfig (#1198) пре 4 година
.env feat: Allow publishing libraries from UI (#4115) пре 3 година
.env.production feat: Allow publishing libraries from UI (#4115) пре 3 година
.eslintignore feat: image support (#4011) пре 3 година
.eslintrc.json chore: Update Typescript to 4.4.4 (#4188) пре 3 година
.gitattributes Add gitattributes (#2164) пре 4 година
.gitignore docs: specify to use yarn v1 not v2 (#3799) пре 3 година
.lintstagedrc.js Keep errors, elements and comments consistent (#2340) пре 4 година
.npmrc Add npmrc to have pinned deps (#727) пре 5 година
.nvmrc Chore: Update .nvmrc to match package.json engines definition (#3148) пре 4 година
.prettierignore Change target branch of coverage and pretty print (#1850) пре 4 година
.watchmanconfig Don't reset cache while zooming using a gesture (#1103) пре 4 година
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) пре 4 година
CONTRIBUTING.md chore: fix npm to yarn in contributing.md and package.json (#3274) пре 3 година
Dockerfile chore: Bump nginx version to newest (#3811) пре 3 година
LICENSE Add MIT License (#176) пре 5 година
README.md docs: Added note on encryption key length (#3995) пре 3 година
crowdin.yml Locale пре 4 година
docker-compose.yml chore: Update action versions and docker build (#3065) пре 4 година
package.json chore(deps-dev): bump @types/web from 0.0.46 to 0.0.47 (#4249) пре 3 година
tsconfig-types.json chore: Update Typescript to 4.4.4 (#4188) пре 3 година
tsconfig.json chore: Update Typescript to 4.4.4 (#4188) пре 3 година
vercel.json fix: redirect excalidraw.com/about to for-webex.excalidraw.com (#4104) пре 3 година
yarn.lock chore(deps-dev): bump @types/web from 0.0.46 to 0.0.47 (#4249) пре 3 година

README.md

Virtual whiteboard for sketching hand-drawn like diagrams.
Collaborative and end-to-end encrypted.

Follow Excalidraw on Twitter

Ask questions or hang out on our discord.gg/UexuTaE.

Try it now

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.

Supporting 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:

Vercel Sentry Crowdin

Documentation

Shortcuts

You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.

Curved lines and arrows

Choose line or arrow and click click click instead of drag.

Charts

You can easily create charts by copy pasting data from Excel or just plain comma separated text.

Translating

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%).

Create a collaboration session manually

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}

Example

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.

Note: Please ensure that the encryption key is 22 characters long.

Shape libraries

Find a growing list of libraries containing assets for your drawings at libraries.excalidraw.com.

Embedding Excalidraw in your App?

Try out @excalidraw/excalidraw. This package allows you to easily embed Excalidraw as a React component into your apps.

Development

Code Sandbox

Local Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Requirements

Clone the repo

git clone https://github.com/excalidraw/excalidraw.git

Install the dependencies

yarn

Start the server

yarn start

Now you can open http://localhost:3000 and start coding in your favorite code editor.

Commands

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

Docker Compose

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

Self-hosting

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.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Notable used tools

And the main source of inspiration for starting the project is the awesome Zwibbler app.