Repository files navigation

Slate-yjs aims to be the goto collaboration solution for slate. Get started in seconds, scale to infinity, customize to your hearts content.

Sponsors ·Why Yjs? ·Live demo ·Documentation ·Packages ·Products ·Questions ·Contributing!

I'm currently looking for sponsors to found further development of slate-yjs. These awesome sponsors already fund the development:

Sana Labs

Hosting provided by:

Yjs offers a feature-rich rich text CRDT with best-in-class performance. It's used in production by multiple fortune 500 companies and is the core of many collaborative editing applications. Moreover, it offers a very mature ecosystem with server-side solutions likehocuspocus, enabling you to build robust and highly scalable collaborative/offline-first applications.

For more detailed benchmarks about performance, you can take a lookhere.

Why a CDRT over OT? While many current collaborative text editing applications rely on OT (e.g., google docs with ShareJS), it only provides a subset of the functionally CRDTs offer due to the dependence on a central server. In other words: CRDTS can do everything OT can, but OT simply can't.

You can read more about thishere.

https://slate-yjs.dev

https://docs.slate-yjs.dev

Slate-yjs's codebase is monorepo managed withyarn workspaces. It consists of a handful of packages—although you won't always use all of them:

Package	Version	Size	Description	Changelog
@slate-yjs/core			Core slate-yjs binding.	CHANGELOG.md
@slate-yjs/react			React specific components/utils for slate-yjs.	CHANGELOG.md

These products use slate-yjs, and can give you an idea of what's possible:

• Dropdeck
• Hugo
• Living Spec
• Saga
• Sana

For questions around yjs, head over to theYjs Community. Trying to build a backend withhocuspocus and have questions? Take a look at the #hocuspocus channel in theTipTap Discord. Having issues with slate? There's a there's aSlack for that as well.

Any questions about slate-yjs? Thead over to the #slate-yjs channel inside theSlate Slack or post something in theDiscussions

All contributions are super welcome! Check out thecontributing instructions for more info!

Slate-yjs isMIT-licensed.