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.
Lipis 418589e7ad
chore: Use @excalidraw/eslint-config (#3142)
4 年之前
.github chore: Consistent job names in GH actions (#3099) 4 年之前
firebase-project Persistent rooms via Firebase (#2188) 4 年之前
public fix: hide scrollbars in zenMode (#3144) 4 年之前
scripts chore: Update translations from Crowdin (#3017) 4 年之前
src chore: Update translations from Crowdin (#3017) 4 年之前
.dockerignore chore: Update action versions and docker build (#3065) 4 年之前
.editorconfig add editorconfig (#1198) 5 年之前
.env chore: Update portal URL (#2689) 4 年之前
.env.production chore: Remove tracking (#2722) 4 年之前
.eslintignore add excalidraw_embed into base repo (#2040) 4 年之前
.eslintrc.json chore: Use @excalidraw/eslint-config (#3142) 4 年之前
.gitattributes Add gitattributes (#2164) 4 年之前
.gitignore build: Switch to Yarn (#3057) 4 年之前
.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) 5 年之前
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) 4 年之前
CONTRIBUTING.md feat: Updates to Collaboration and RTL UX (#2994) 4 年之前
Dockerfile build: Switch to Yarn (#3057) 4 年之前
LICENSE Add MIT License (#176) 5 年之前
README.md build: Switch to Yarn (#3057) 4 年之前
crowdin.yml Locale 5 年之前
docker-compose.yml chore: Update action versions and docker build (#3065) 4 年之前
package.json chore: Use @excalidraw/eslint-config (#3142) 4 年之前
tsconfig.json fix: Consistent case for export locale strings (#2622) 4 年之前
vercel.json refactor: Use the latest vercel configuration instead of now (#2893) 4 年之前
yarn.lock chore: Use @excalidraw/eslint-config (#3142) 4 年之前

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.

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.

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

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.