jupyterlab-yjs-example

Archived

**This project is archived. JupyterLab 3.1+ now has support real time collaboration: **

https://jupyterlab.readthedocs.io/en/stable/user/rtc.html

---

Example of using Yjs in JupyterLab for collaborative editing.

Try it on Binder

This example can be tested on Binder with several people:

1. Open a file
2. Click on Share > Share Jupyter Server Link
3. Copy the link
4. Send the link

It is also possible to use JupyterLab Classic to edit the file:

Requirements

• JupyterLab >= 3.0

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-yjs-example directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False