ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update content

Browse Source
This commit is contained in:
Hans Pagel
2021-02-04 16:56:17 +01:00
parent ff7cc7894d
commit d40131d8d1
8 changed files with 58 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/src/docPages/examples/collaborative-editing.md
View File

@@ -1,16 +1,25 @@
# Collaborative editing
:::pro Commercial use
Using the collaborative editing commercially? [Become a sponsor](/sponsor) to fund its development!
:::
## toc
## Introduction
This example shows how you can use tiptap to let multiple users collaborate in the same document in real-time.
It connects all clients to a WebSocket server and merges changes to the document with the power of [Y.js](https://github.com/yjs/yjs). If you want to learn more about collaborative text editing, check out [our guide on collaborative editing](/guide/collaborative-editing).
## Example
:::warning Shared Document
Be nice! The content of this editor is shared with other users from the Internet.
:::
<demo name="Examples/CollaborativeEditing" />
In case you’re wondering what kind of sorcery you need on the server to achieve this, here is the backend code for the demo:
## Backend
In case you’re wondering what kind of sorcery you need on the server to achieve this, here is the whole backend code for the demo:
```js
import { Server } from '@hocuspocus/server'

1
docs/src/docPages/examples/drawing.md
View File

@@ -1,5 +1,4 @@
# Drawing
Did you ever wanted to draw in a text editor? Me neither. Anyway, here is an example how that could work with tiptap. If you want to build something like that, [learn more about node views](/guide/node-views).
<demo name="Examples/Drawing" />

2
docs/src/docPages/guide/collaborative-editing.md
View File

@@ -1,6 +1,6 @@
# Collaborative editing
:::pro Professionals
:::pro Commercial use
Using the collaborative editing commercially? [Become a sponsor](/sponsor) to fund its development!
:::

2
docs/src/docPages/overview/installation.md
View File

@@ -3,7 +3,7 @@
## toc
## Introduction
There are a few different ways to install tiptap, depending on how your development setup looks like. We have put together integration guides for a few popular frameworks to get you started quickly. You can even use tiptap without any front-end framework, too. Choose the way that fits your workflow and start building cool things!
There are a few different ways to install tiptap, depending on your development setup. We have put together integration guides for a few popular frameworks to get you started quickly. You can even use tiptap without any front-end framework, too. Choose the way that fits your workflow and start building cool things!
## Integration guides
* [Vue.js](/guide/getting-started/vue)