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

Remove references to docs script (#1003)

Browse source 
* remove references to yarn docs

* add back ref to source & ts
This commit is contained in:
Patrick Hultquist 2022-10-03 06:55:10 -04:00 committed by GitHub
parent e722fcdb4d
commit 8a198c6d42
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 1 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
guides/development.md
View file

@ -13,5 +13,3 @@ From the root folder:
Other scripts:
- Run `yarn test` to execute unit tests via [Jest](https://jestjs.io).
- Run `yarn docs` to build the docs via [ts-doc](https://typedoc.org/).

17
guides/documentation.md
View file

@ -4,15 +4,6 @@
This file contains the documentation for the `<Tldraw>` component as well as the data model that the component accepts.
In addition to the docs written below, this project also includes **generated documentation**. To view the generated docs:
1. Run `yarn docs` from the root folder
2. Open the file at:
```
/packages/tldraw/docs/classes/TldrawApp.html
```
## `tldraw`
The `Tldraw` React component is the [tldraw](https://tldraw.com) editor exported as a standalone component. You can control the editor through props, or through the `TldrawApp`'s imperative API. **All props are optional.**
@ -217,12 +208,6 @@ function App() {
}
```
To view the full documentation of the `TldrawApp` API, generate the project's documentation by running `yarn docs` from the root folder, then open the file at:
```
/packages/tldraw/docs/classes/TldrawApp.html
```
Here are some useful methods:
- `loadDocument`
@ -269,4 +254,4 @@ Here are some useful methods:
- `selectTool`
- `cancel`
Check the generated docs, source or the TypeScript types for more on these and other methods.
Check the source or the TypeScript types for more on these and other methods.