c5fe399842
This PR changes the structure of the docs site's sidebar.  I think this signposts more clearly what the different pages are for. And it also paves the way for some work I want to do on expanding+refining the Editor docs. This PR also simplifies URL for all sidebar links. It's a bit scrappy, but I think it feels simple enough to work with, and easy-enough to change in the future. > But hey! I've been doing this a couple times recently. Maybe we should refactor? Or maybe we should keep going with what we've got and focus on getting these docs *done*. ### 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. Check that all the sidebar links go to where you expect. 2. Check that old URLs redirect to the right pages, eg: `/docs/usage` should go to the usage page. ### Release Notes - Documentation: Restructured the sidebar for clarity.
29 lines
No EOL
778 B
Text
29 lines
No EOL
778 B
Text
---
|
|
title: Installation
|
|
status: published
|
|
author: steveruizok
|
|
date: 3/22/2023
|
|
order: 1
|
|
---
|
|
|
|
At the moment the `@tldraw/tldraw` package is in alpha. We also ship a canary version which is always up to date with the main branch of tldraw [repository](https://github.com/tldraw/tldraw).
|
|
|
|
## Alpha
|
|
|
|
First, install the `@tldraw/tldraw` package using `@alpha` for the latest.
|
|
|
|
```bash
|
|
yarn add @tldraw/tldraw@alpha
|
|
# or
|
|
npm install @tldraw/tldraw@alpha
|
|
```
|
|
|
|
## Canary
|
|
|
|
To get the very latest version, use the [latest canary release](https://www.npmjs.com/package/@tldraw/tldraw?activeTab=versions). Docs for the very latest version are also available at [canary.tldraw.dev](https://canary.tldraw.dev).
|
|
|
|
```bash
|
|
yarn add @tldraw/tldraw@canary
|
|
# or
|
|
npm install @tldraw/tldraw@canary
|
|
``` |