PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Add docs (#2470)

Browse source 
This PR adds the docs app back into the tldraw monorepo.

## Deploying

We'll want to update our deploy script to update the SOURCE_SHA to the
newest release sha... and then deploy the docs pulling api.json files
from that release. We _could_ update the docs on every push to main, but
we don't have to unless something has changed. Right now there's no
automated deployments from this repo.

## Side effects

To make this one work, I needed to update the lock file. This might be
ok (new year new lock file), and everything builds as expected, though
we may want to spend some time with our scripts to be sure that things
are all good.

I also updated our prettier installation, which decided to add trailing
commas to every generic type. Which is, I suppose, [correct
behavior](https://github.com/prettier/prettier-vscode/issues/955)? But
that caused diffs in every file, which is unfortunate.

### Change Type

- [x] `internal` — Any other changes that don't affect the published
package[^2]
This commit is contained in:
Steve Ruiz 2024-01-15 12:33:15 +00:00 • committed by GitHub
parent 1f425dcab3
commit 29044867dd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
221 changed files with 108461 additions and 3103 deletions
Download patch file Download diff file Expand all files Collapse all files

15
apps/docs/content/getting-started/examples.mdx Normal file
View file

@ -0,0 +1,15 @@
---
title: Examples
status: published
author: steveruizok
date: 10/11/2023
order: 3
---
Here's a [very simple sandbox](https://codesandbox.io/s/tldraw-example-canary-2lrzmy) showing the tldraw component.
You can also find simple [framework-specific examples](https://github.com/tldraw/examples). For a multiplayer example using a collaboration backend, see our [Yjs example](https://github.com/tldraw/tldraw-yjs-example).
For more specific examples of how to use the tldraw component, check out the [tldraw repository's examples app](https://github.com/tldraw/tldraw/blob/main/apps/examples/src). The [tldraw repo](https://github.com/tldraw/tldraw) has more information about running the examples locally. The examples are also available in a [sandbox](https://stackblitz.com/github/tldraw/tldraw/tree/examples?file=src%2Findex.tsx) shown below:
<Embed src="https://stackblitz.com/github/tldraw/tldraw/tree/examples?embed=1&file=src%2Findex.tsx&theme=dark" />