Yjs

Make the editor collaborative by integrating Yjs with ProseKit.

Code

Usage

You need to install yjs and y-prosemirror to use this extension.

npm

npm install yjs y-prosemirror

yarn

yarn add yjs y-prosemirror

pnpm

pnpm add yjs y-prosemirror

import 'prosekit/extensions/yjs/style.css'
import * as Y from 'yjs'
import { defineYjs } from 'prosekit/extensions/yjs'
import { WebsocketProvider } from 'y-websocket'

const doc = new Y.Doc()
const provider = new WebsocketProvider(
  'ws://localhost:1234',
  'my-roomname',
  doc,
)

const extension = defineYjs({ doc, awareness: provider.awareness })

API Reference

• prosekit/extensions/yjs