tldraw/apps/vscode/extension/README.md
2023-04-25 12:01:25 +01:00

25 lines
1.1 KiB
Markdown

## Introduction
[tldraw](https://tldraw.com) is a very good whiteboard for the web. This extension will let you use tldraw inside of VS Code, using offline `.tldr` files. Create drawings, diagrams, or visual documentation, and then commit the files alongside your code!
![A screenshot of tldraw in VS Code](https://assets.tldraw.xyz/uploads/6Jnp8CCAr7gn2To06NF8r-vscode-screenshot.png)
## Usage
- To create a new tldraw file, use the provided command: "tldraw: New tldraw File".
![A recording of opening tldraw in VS Code](https://assets.tldraw.xyz/uploads/vx7dEFbx2oURPB3vw8x0E-vscode-recording.gif)
- To view an existing tldraw file, open a file with the `.tldr` extension in VS Code.
> **Tip:** The `.tldr` files you create with this extension can also be opened in the tldraw [web app](https://tldraw.com). You can also use this extension to open `.tldr` files saved from the web app.
## Community
### Support
Need help? Please [open an issue](https://github.com/tldraw/tldraw-beta/issues/new/choose) for support.
### Discussion
Want to connect with the developers or users? Visit the [Discord channel](https://discord.gg/SBBEVCA4PG).