History

Steve Ruiz 29044867dd Add docs (#2470 ) 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]		2024-01-15 12:33:15 +00:00
..
api	Add docs (#2470 )	2024-01-15 12:33:15 +00:00
scripts	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00
src	Add docs (#2470 )	2024-01-15 12:33:15 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	Add docs (#2470 )	2024-01-15 12:33:15 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2024-01-10 12:03:59 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
package.json	[improvement] update dark mode (#2468 )	2024-01-13 18:04:19 +00:00
README.md	add descriptions to examples (#2375 )	2023-12-27 17:17:18 +00:00
setupTests.js	[fix] Asset versions (#2389 )	2023-12-31 11:07:38 +00:00
tsconfig.json	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00

README.md

@tldraw/tldraw

This package contains the source code for the tldraw library. Learn more at our docs site: tldraw.dev.

Installation

Install the @tldraw/tldraw package using @canary for the latest canary release. (Or @alpha for the latest alpha release.)

yarn add @tldraw/tldraw@canary
# or
npm install @tldraw/tldraw@canary
# or
pnpm i @tldraw/tldraw@canary

Then start the local development server.

yarn dev
# or
npm run dev
# or
pnpm dev

Usage

An extremely minimal usage (without our UI) might look like this:

import { Tldraw } from '@tldraw/tldraw'
import '@tldraw/tldraw/tldraw.css'

export default function () {
	return <Tldraw/>
}

See the examples folder for more examples.

Community

Have questions, comments or feedback? Join our discord or start a discussion.

Distributions

You can find tldraw on npm here.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

License

The tldraw source code and its distributions are provided under the tldraw license. This license does not permit commercial use.

If you wish to use this project in commercial product, you need to purchase a commercial license. Please contact us at hello@tldraw.com for more inforion about obtaining a commercial license.

Trademarks

Contact

Find us on Twitter at @tldraw or email hello@tldraw.com. You can also join our discord for quick help and support.