Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt

Use this file to discover all available pages before exploring further.

Enable multiple users to edit the same document simultaneously with real-time collaboration powered by Yjs.
Collaboration is configured through modules.collaboration today, but it isn’t a built-in UI surface. It controls document sync, providers, presence, and persistence for collaborative editing: infrastructure, not rendering. Use it alongside any UI choice (Custom UI, built-in UI, or both).

​
Choose your approach

No server to manage: get started in minutes.
ProviderBest ForPricing
LiveblocksQuick start, any frameworkFree tier available

​
Quick start

Get collaboration working in 5 minutes with Liveblocks: 
npm install @liveblocks/client @liveblocks/yjs yjs

import { createClient } from "@liveblocks/client";
import { LiveblocksYjsProvider } from "@liveblocks/yjs";
import * as Y from "yjs";
import { SuperDoc } from "superdoc";

const client = createClient({ publicApiKey: "pk_..." });
const { room } = client.enterRoom("my-document");
const ydoc = new Y.Doc();
const provider = new LiveblocksYjsProvider(room, ydoc);

provider.on("sync", (synced) => {
  if (!synced) return;

  new SuperDoc({
    selector: "#editor",
    user: { name: "John", email: "john@example.com" },
    modules: {
      collaboration: { ydoc, provider },
    },
  });
});
See the full quickstart guide for framework-specific examples (React, Vue, Vanilla JS).

​
Start collaborative immediately or later

Start in collaboration mode

Create your Yjs provider first, then pass { ydoc, provider } in modules.collaboration when you construct SuperDoc.

Upgrade later

Mount a local SuperDoc first, then call superdoc.upgradeToCollaboration({ ydoc, provider }) when the user creates a shared room.
If you are also using the SDK for backend automation, see SDK collaboration sessions.