Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

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

HERO uses Hocuspocus and Y.js for realtime collaborative editing.

Connection

  • URL: wss://collab.myhero.so
  • Auth: Bearer token (same personal access token as REST). Provide it via the token field on the Y.js provider config.

Active extensions

  • Server — (no description)
  • Database — Persists Y.Doc updates to MongoDB on every change.
  • Logger — Logs connection lifecycle events.
  • Error — (no description)

Example client

import { HocuspocusProvider } from "@hocuspocus/provider";

const provider = new HocuspocusProvider({
  url: "wss://collab.myhero.so",
  name: "<documentId>",
  token: "<your HERO personal access token>",
});
provider.document is a Y.Doc you can bind to your TipTap editor or any Y.js-compatible UI.