@veltdev/superdoc-crdt
v1.0.1
Published
Velt CRDT wrapper for SuperDoc
Readme
Velt SuperDoc CRDT Core Library
With Velt SuperDoc CRDT Core Library, you can add powerful multiplayer editing and state synchronization features to any JavaScript application using SuperDoc. Works with Angular, Vue, Svelte, Solid, and Vanilla JS.
The library provides framework-agnostic realtime primitives:
- Universal API for managing shared state and providers
- Fully-managed on a scalable realtime backend
- Powered by Yjs for industry-standard conflict resolution
Features include:
- Multiplayer Editing with real-time synchronization
- Collaboration with presence and cursors
- Conflict Resolution ensuring document consistency across all clients
- Offline Support with automatic synchronization upon reconnection
- Cross-Framework Support (Angular, Vue, Svelte, Solid, Vanilla JS)
- ... and so much more
Installation
npm install @veltdev/superdoc-crdt superdoc yjs y-prosemirror prosemirror-model prosemirror-state prosemirror-transform prosemirror-view @hocuspocus/provider pdfjs-dist reactDocumentation
- Read the documentation for setup guides and API references.
Use cases
The SuperDoc CRDT library is used to power:
- Collaborative editing tools
- Real-time document workspaces
- Internal wikis and knowledge bases
- Shared meeting notes and agendas
- Any shared, mutable environment
Resources
- Explore multiplayer editing to see features like collaborative text, whiteboards, and data grids.
- Sample Apps: Check out example implementations for various use cases.
Releases
- See the latest changes.
Security
- Velt is SOC2 Type 2 and HIPAA compliant. Learn more
Community
- X: To receive updates, announcements, and general Velt tips.
