tiptap/docs/src/docPages/api/extensions/collaboration.md

37 lines
1.1 KiB
Markdown
Raw Normal View History

2020-08-20 21:33:16 +08:00
# Collaboration
2020-10-28 23:49:44 +08:00
The Collaboration extension enables you to collaborate with others on one document. The implementation is based on [Y.js by Kevin Jahns](https://github.com/yjs/yjs), which is the coolest thing to [integrate collaborative editing](/guide/collaborative-editing) in your project.
:::premium Premium Extension
2020-10-29 04:53:40 +08:00
Using this in production requires a **tiptap pro** license. [Read more](/sponsor)
2020-10-28 23:49:44 +08:00
:::
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-collaboration yjs y-webrtc
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-collaboration yjs y-webrtc
```
## Settings
| Option | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| provider | | | |
| type | | | |
## Commands
*None*
## Keyboard shortcuts
*None*
## Source code
[packages/extension-collaboration/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration/)
## Usage
2020-09-27 03:04:33 +08:00
:::warning Public
The content of this editor is shared with other users.
:::
<demo name="Extensions/Collaboration" highlight="" />