2.3 KiB
2.3 KiB
Welcome to the tldraw monorepo. Here you'll find the source code for @tldraw/tldraw, @tldraw/core, and the tldraw.com website.
🙌 Questions? Join the Discord channel or start a discussion.
💕 Love this project? Consider becoming a sponsor.
Contents
This repository is a monorepo containing two packages:
- packages/tldraw contains the source for the @tldraw/tldraw package. This is an editor as a React component named
<Tldraw>. You can use this package to embed the tldraw editor in any React application. - packages/core contains the source for the @tldraw/core package. This is a renderer for React components in a canvas-style UI. It is used by
@tldraw/tldrawas well as several other projects.
...three apps:
- apps/www contains the source for the tldraw.com website.
- apps/vscode contains the source for the tldraw VS Code extension.
- apps/electron contains the source for an experimental Electron app.
...and three examples:
- examples/core-example is a simple example for
@tldraw/core. - examples/core-example-advanced is a second example for
@tldraw/core. - examples/tldraw-example is an example for
@tldraw/tldraw.
Contribution
See the contributing guide.
Support
Need help? Please open an issue for support.
Discussion
Want to connect with other devs? Visit the Discord channel.
License
This project is licensed under MIT.
If you're using the library in a commercial product, please consider becoming a sponsor.