FlyLaTeX Whiteboard

This is a fork of Excalidraw with some modifications to make it work with FlyLaTeX.

Modifications

• Adds support for the flylatex theme.
• Change default context to /app.
• Integration with FlyLaTeX.
• Change some Label to flylatex.
• UI default language is zh-CN.

Build

First Step:

clone the repository and install the dependencies.

Important: The node version must in [18.17.1] range.

build the product with flow commands:

yarn
yarn build

Second Step:

copy the build folder to the flylatex server and build the docker image.

sudo docker build -t your-docker-image-hub/excalidraw .

Node Version Range

Node version must in [18.17-20.x] range.

Build failed when node version out of range.

excalidraw-monorepo@: The engine "node" is incompatible with this module. Expected version "18.0.0 - 20.x.x". Got "22.5.1"

next@14.1.4: The engine "node" is incompatible with this module. Expected version ">=18.17.0". Got "18.8.0"

Recommend to use node version 18.17.1.

Tips

set the proxy:

# for example, set the proxy to 7890 port
yarn config set https-proxy http://127.0.0.1:7890

Important

This project is one part of FlyLaTeX.

Excalidraw

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

• 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

• VScode extension
• npm package

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: