1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-31 02:49:56 +02:00

Add "Enabling Collaborative Editing" Yjs guide to the docs (#5505)

* feat: Making a start

* feat: Draft guide, showing all Yjs, then Liveblocks, then Slate-yjs

* feat: Fixed code snippets

* feat: websocket -> WebSocket

* feat: Renaming page

* feat: Title change

* feat: Add provider to resources

* feat: Clarity

* feat: Update Plate link

* feat: Mention Yjs providers

* feat: Actually update the Plate link

Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>

---------

Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
This commit is contained in:
Chris Nicholas
2023-09-05 18:23:24 +01:00
committed by GitHub
parent a81f76f3a3
commit 70166d6386
3 changed files with 423 additions and 9 deletions

View File

@@ -6,16 +6,21 @@ A few resources that are helpful for building with Slate.
These libraries are helpful when developing with Slate:
- [`is-hotkey`](https://github.com/ianstormtaylor/is-hotkey) is a simple way to check whether an `onKeyDown` handler should fire for a given hotkey, handling cross-platform concerns like cmd vs. ctrl keys for you automatically.
- [`is-hotkey`](https://github.com/ianstormtaylor/is-hotkey) is a simple way to check whether an `onKeyDown` handler
should fire for a given hotkey, handling cross-platform concerns like cmd vs. ctrl keys for you automatically.
## Extensions and Plugins
These extensions and plugins add additional features and capabilities to Slate:
- [@liveblocks/yjs](https://liveblocks.io/docs/api-reference/liveblocks-yjs) A fully-hosted WebSocket infrastructure and
persisted data store for Yjs documents
- [Plate](https://github.com/udecode/plate) Rich text editor plugin system for Slate & React
- [`slate-angular`](https://github.com/worktile/slate-angular) Angular-based view layer, which is a useful supplement to Slate for building a rich text editor using Angular.
- [`slate-angular`](https://github.com/worktile/slate-angular) Angular-based view layer, which is a useful supplement to
Slate for building a rich text editor using Angular.
- [`slate-yjs`](https://github.com/BitPhinix/slate-yjs/) Collaborative editing utilities for Slate leveraging Yjs
- [`slate-collaborative`](https://github.com/cudr/slate-collaborative) Collaborative editing utilities for Slate leveraging Automerge
- [`slate-collaborative`](https://github.com/cudr/slate-collaborative) Collaborative editing utilities for Slate
leveraging Automerge
## Products
@@ -53,15 +58,22 @@ These products use Slate, and can give you an idea of what's possible:
These pre-packaged editors are built on top of Slate, and can be helpful to see how you might structure your code:
- [Accord Project Markdown Editor](https://github.com/accordproject/web-components) is a WYSIWYG editor for [CommonMark](https://commonmark.org/).
- [Accord Project Markdown Editor](https://github.com/accordproject/web-components) is a WYSIWYG editor
for [CommonMark](https://commonmark.org/).
- [Canner Editor](https://github.com/Canner/canner-slate-editor) is a rich text editor.
- [Chatterslate](https://github.com/chatterbugapp/chatterslate) helps teach language grammar and more at [Chatterbug](https://chatterbug.com).
- [Chatterslate](https://github.com/chatterbugapp/chatterslate) helps teach language grammar and more
at [Chatterbug](https://chatterbug.com).
- [CoCalc](https://github.com/sagemathinc/cocalc/) Collaborative Calculation editor in the Cloud
- [French Press Editor](https://github.com/roast-cms/french-press-editor) is a customizeable editor with offline support.
- [French Press Editor](https://github.com/roast-cms/french-press-editor) is a customizeable editor with offline
support.
- [Nossas Editor](http://slate-editor.bonde.org/) is a drop-in WYSIWYG editor.
- [React Force Slate Editor](https://github.com/nareshbhatia/react-force/tree/master/packages/slate-editor) is a light-weight medium-style editor with no editor chrome.
- [React Page](https://github.com/react-page/react-page) is a self-contained, customizable inline WYSIWYG editor library.
- [Slate Plugins Next](https://github.com/zbeyens/slate-plugins-next) provides an editor with configurable and extendable plugins.
- [React Force Slate Editor](https://github.com/nareshbhatia/react-force/tree/master/packages/slate-editor) is a
light-weight medium-style editor with no editor chrome.
- [React Page](https://github.com/react-page/react-page) is a self-contained, customizable inline WYSIWYG editor
library.
- [Plate (Plugins for Slate)](https://github.com/udecode/plate) provides an editor with configurable and
extendable plugins.
-
- [Tripdocs](https://github.com/ctripcorp/tripdocs): It's a modern, production-ready rich text editor.
\(Or, if you have their exact use case, can be a drop-in editor for you.\)