Skip to content

Commit b6c5ce2

Browse files
Add Liveblocks info and BlockNote download command (#540)
* Update real-time-collaboration.md * feat: Example image * feat: Replace image with video * Fixed video --------- Co-authored-by: Matthew Lipski <[email protected]>
1 parent b5ccd1a commit b6c5ce2

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

packages/website/docs/docs/real-time-collaboration.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ const editor = useBlockNote({
4444

4545
When a user edits the document, an incremental change (or "update") is captured and can be shared between users of your app. You can share these updates by setting up a _Yjs Provider_. In the snipped above, we use [y-webrtc](https://github.com/yjs/y-webrtc) which shares updates over WebRTC (and BroadcastChannel), but you might be interested in different providers for production-ready use cases.
4646

47+
- [Liveblocks](https://liveblocks.io/yjs) A fully hosted WebSocket infrastructure and persisted data store for Yjs documents. Includes webhooks, REST API, and browser DevTools, all for Yjs
4748
- [PartyKit](https://www.partykit.io/) A serverless provider that runs on Cloudflare
4849
- [Hocuspocus](https://www.hocuspocus.dev/) open source and extensible Node.js server with pluggable storage (scales with Redis)
4950
- [y-websocket](https://github.com/yjs/y-websocket) provider that you can connect to your own websocket server
@@ -52,6 +53,18 @@ When a user edits the document, an incremental change (or "update") is captured
5253
- [Matrix-CRDT](https://github.com/yousefED/matrix-crdt) syncs updates over Matrix (experimental)
5354
- [Nostr-CRDT](https://github.com/yousefED/nostr-crdt) syncs updates over Nostr (experimental)
5455

56+
## Liveblocks
57+
58+
Liveblocks provides a hosted back-end for Yjs which allows you to download and set up a real-time multiplayer BlockNote example with one command.
59+
60+
```shell
61+
npx create-liveblocks-app@latest --example nextjs-yjs-blocknote-advanced
62+
```
63+
64+
<video autoplay loop src="/img/screenshots/liveblocks_blocknote_example.mp4" aria-label="BlockNote example using Liveblocks Yjs, showing collaboration and DevTools" />
65+
66+
You can also try the same example in a [live demo](https://liveblocks.io/examples/collaborative-text-editor-advanced/nextjs-yjs-blocknote-advanced). To start with Liveblocks and BlockNote make sure to follow their [getting started guide](https://liveblocks.io/docs/get-started/yjs-blocknote-react).
67+
5568
## Partykit
5669

5770
For development purposes, you can use our Partykit server to test collaborative features. Replace the `WebrtcProvider` provider in the example below with a `YPartyKitProvider`:
Binary file not shown.

0 commit comments

Comments
 (0)