a316fd2ab4
This PR adds links to the API reference from within the docs pages. I think we should continue with this as we move forwards with more content. We could tweak the threshold of what we link or don't link. I tried to strike a good balance (maybe linked too much though). We'd want lots of stuff to be clickable, so that users can dive into the API. But we don't want the screen to be a splattering of blue, distracting away from more important stuff. ### Change Type - [x] `documentation` — Changes to the documentation only[^2] [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Try out some of the newly added links on the docs site. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - Documentation: Added links to API reference in guides.
50 lines
No EOL
2.3 KiB
Text
50 lines
No EOL
2.3 KiB
Text
---
|
|
title: Introduction
|
|
status: published
|
|
author: steveruizok
|
|
date: 3/22/2023
|
|
order: 0
|
|
---
|
|
|
|
Welcome to the tldraw developer docs.
|
|
|
|
Here at tldraw, we make two things: a very good multiplayer whiteboard (at [tldraw.com](https://tldraw.com)), and the [open source library](https://github.com/tldraw/tldraw) that powers it. This page provides documentation and reference for that open source library.
|
|
|
|
```tsx
|
|
import { Tldraw } from '@tldraw/tldraw'
|
|
import '@tldraw/tldraw/tldraw.css'
|
|
|
|
export default function () {
|
|
return (
|
|
<div style={{ position: 'fixed', inset: 0 }}>
|
|
<Tldraw />
|
|
</div>
|
|
)
|
|
}
|
|
```
|
|
|
|
You can use the [`<Tldraw>`](/gen/tldraw/Tldraw) React component to build on top of the default tldraw experience. It's easy to use and easy to extend with your own [custom shapes](/docs/shapes), [custom tools](/docs/tools), and [user interface](/docs/user-interface) overrides.
|
|
|
|
You can also use the [Editor API](/docs/editor) to create, update, and delete shapes, control the camera, or do just about anything else.
|
|
|
|
If you want to go even deeper, you can use the [`<TldrawEditor>`](/gen/editor/TldrawEditor) component as a more minimal engine without the default tldraw shapes or user interface.
|
|
|
|
|
|
Best of all, you can easily plug tldraw into the [collaboration backend](/docs/collaboration) of your choice.
|
|
|
|
- Want to explore the code? Visit the [GitHub repo](https://github.com/tldraw/tldraw).
|
|
- Want to try it out? Visit the [examples sandbox](https://stackblitz.com/github/tldraw/tldraw/tree/examples?file=src%2F1-basic%2FBasicExample.tsx).
|
|
|
|
Otherwise, continue on to the [installation](/docs/installation) and [usage](/docs/usage) guides.
|
|
|
|
## Community
|
|
|
|
Found a bug or want to request a feature? Create an issue [here](https://github.com/tldraw/tldraw/issues). To connect with the team and other users, join us on our [Discord](https://discord.gg/JMbeb96jsh).
|
|
|
|
If you spot an issue with these docs, please use the links at the bottom of each page to suggest a change.
|
|
|
|
## License
|
|
|
|
Our open source libraries are licensed and distributed under Apache-2.0.
|
|
|
|
Our plan is to keep these libraries permissively licensed while we develop a commercial offering for teams who want more from tldraw. If you're planning to use use tldraw in a commercial product, please reach out at [hello@tldraw.com](mailto://hello@tldraw.com). |