# @jupyter/ydoc

> Jupyter document structures for collaborative editing using YJS

Latest version **4.1.1** (published 2026-07-06) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @jupyter/ydoc
pnpm add @jupyter/ydoc
yarn add @jupyter/ydoc
bun add @jupyter/ydoc
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2026-07-06 |
| First published | 2022-11-29 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 217.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 45 |
| Author | Project Jupyter |
| Maintainers | fcollonval, vidartf, davidbrochart, jtpio, blink1073, darian, ajbozarth, zsailer, jupyter-release-bot, jupyter-server-release-bot, krassowski |

## Links

- npm: https://www.npmjs.com/package/@jupyter/ydoc
- Repository: https://github.com/jupyter-server/jupyter_ydoc
- Issues: https://github.com/jupyter-server/jupyter_ydoc/issues
- npm.io page: https://npm.io/package/@jupyter/ydoc

## Dependencies (6)

- [yjs](https://npm.io/package/yjs.md) ^13.5.40
- [y-protocols](https://npm.io/package/y-protocols.md) ^1.0.5
- [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^1.11.0 || ^2.0.0
- [@lumino/signaling](https://npm.io/package/@lumino/signaling.md) ^1.10.0 || ^2.0.0
- [@lumino/disposable](https://npm.io/package/@lumino/disposable.md) ^1.10.0 || ^2.0.0
- [@jupyterlab/nbformat](https://npm.io/package/@jupyterlab/nbformat.md) ^3.0.0 || ^4.0.0-alpha.21 || ^4.0.0

## Recent versions

- 4.1.1 (latest) — 2026-07-06
- 4.0.0-b1 (next) — 2026-06-11
- 4.1.0 — 2026-07-01
- 4.0.0 — 2026-06-15
- 3.5.0 — 2026-06-03
- 4.0.0-b0 — 2026-05-28
- 4.0.0-a3 — 2026-05-25
- 4.0.0-a2 — 2026-05-08
- 4.0.0-a1 — 2026-05-07
- 4.0.0-a0 — 2026-04-22
- 3.4.1 — 2026-04-14
- 3.4.0 — 2026-02-06
- 3.3.6 — 2026-02-05
- 3.3.5 — 2026-02-03
- 3.3.4 — 2026-01-09
- … 53 more at https://npm.io/package/@jupyter/ydoc/versions

## README

# @jupyter/ydoc

`@jupyter/ydoc` provides [Yjs](https://github.com/yjs/yjs)-based data structures for various
documents used in the Jupyter ecosystem. Built-in documents include:
- `YFile`: a generic text document.
- `YNotebook`: a Jupyter notebook document.

The API documentation is available [there](https://jupyter-ydoc.readthedocs.io/en/latest/api/index.html).

---
_Source: https://npm.io/package/@jupyter/ydoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._