Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 11 commits into from
Sep 5, 2023
1 change: 1 addition & 0 deletions docs/Summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Applying Custom Formatting](walkthroughs/04-applying-custom-formatting.md)
- [Executing Commands](walkthroughs/05-executing-commands.md)
- [Saving to a Database](walkthroughs/06-saving-to-a-database.md)
- [Enabling Collaborative Editing](walkthroughs/07-enabling-collaborative-editing.md)
- [Using the Bundled Source](walkthroughs/xx-using-the-bundled-source.md)

## Concepts
Expand Down
30 changes: 21 additions & 9 deletions docs/general/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.\)
Loading
Loading