Skip to content

Commit

Permalink
Adapt for CodeMirror v6
Browse files Browse the repository at this point in the history
  • Loading branch information
curran committed Jan 4, 2022
1 parent afd2a49 commit 7b6b774
Show file tree
Hide file tree
Showing 18 changed files with 914 additions and 3,300 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# codemirror-ot
Real-time collaboration plugin for CodeMirror 6. For background & writeup, see [Medium: Codemirror 6 Experiments](https://medium.com/@currankelleher/codemirror-6-experiments-a3930bf03781).

At its core this library is a translator between [JSON Operational Transformation](https://github.com/ottypes/json0) and [CodeMirror 6](https://codemirror.net/6/) [transactions](https://codemirror.net/6/design.html#state).
Recently overhauled (May 2022) to work with the latest CodeMirror 6 APIs and [JSON1](https://github.com/ottypes/json1). A fully functioning collaborative editor that leverages this library can be found in [vizhub-codemirror](https://github.com/vizhub-core/vizhub/tree/main/vizhub-v3/vizhub-codemirror).

This is one piece of the puzzle for enabling real-time collaboration on text documents using CodeMirror and [ShareDB](https://github.com/teamwork/sharedb).
At its core this library is a translator between [JSON Operational Transformation](https://github.com/ottypes/json0) and [CodeMirror 6](https://codemirror.net/6/). This is one piece of the puzzle for enabling real-time collaboration on text documents using CodeMirror and [ShareDB](https://github.com/teamwork/sharedb).

Related work:
Related work (new):

* https://github.com/codemirror/collab/blob/main/src/collab.ts
* https://codemirror.net/6/examples/collab/
* https://github.com/yjs/y-codemirror.next/blob/main/src/y-sync.js

Related work (old):
* https://github.com/prosemirror/prosemirror-collab - A collaboration module for ProseMirror.
* https://github.com/FirebaseExtended/firepad - An active project using Firebase and CodeMirror.
* https://github.com/gkjohnson/collaborative-code-editor - A 2017 integration of ShareDB and CodeMirror.
Expand Down
Loading

0 comments on commit 7b6b774

Please sign in to comment.