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

docs: clean up

Browse Source
This commit is contained in:
Hans Pagel
2021-09-16 14:31:54 +02:00
parent e012a29240
commit 3c176f6e3e
3 changed files with 0 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/docPages/experiments.md
View File

@@ -4,13 +4,11 @@ Congratulations! You’ve found our playground with a list of experiments. Be aw
## Experimental examples ## Experimental examples
* [Linter](/experiments/linter) * [Linter](/experiments/linter)
* [Content of multiple editors in a single Y.js](/experiments/multiple-editors) * [Content of multiple editors in a single Y.js](/experiments/multiple-editors)
* [Global drag handle](/experiments/global-drag-handle)
* [Generic Figure](/experiments/generic-figure) * [Generic Figure](/experiments/generic-figure)
## Experimental extensions ## Experimental extensions
* [@tiptap/extension-command-menu](/experiments/commands) * [@tiptap/extension-command-menu](/experiments/commands)
* [@tiptap/extension-iframe](/experiments/embeds) * [@tiptap/extension-iframe](/experiments/embeds)
* [@tiptap/extension-toggle-list](/experiments/details) * [@tiptap/extension-toggle-list](/experiments/details)
* [@tiptap/extension-collaboration-annotation](/experiments/collaboration-annotation)
* [@tiptap/extension-trailing-node](/experiments/trailing-node) * [@tiptap/extension-trailing-node](/experiments/trailing-node)
* [@tiptap/extension-figure](/experiments/figure) * [@tiptap/extension-figure](/experiments/figure)

46
docs/src/docPages/experiments/collaboration-annotation.md
View File

@@ -1,46 +0,0 @@
# CollaborationAnnotation
<!-- [![Version](https://img.shields.io/npm/v/@tiptap/extension-collaboration-annotation.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-collaboration-annotation)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-collaboration-annotation.svg)](https://npmcharts.com/compare/@tiptap/extension-collaboration-annotation?minimal=true) -->
⚠️ Experiment
:::warning Don’t use this in production
This extension still has major issues (for example https://github.com/yjs/y-prosemirror/issues/44). We’re looking for funding to finish the extension. If you think you can help with that, reach out to humans@tiptap.dev!
:::
Annotations can be used to add additional information to the content, for example comments. They live on a different level than the actual editor content.
<!-- :::pro Pro Extension
We kindly ask you to [sponsor our work](/sponsor) when using this extension in production.
::: -->
## Installation
```bash
# with npm
npm install @tiptap/extension-collaboration-annotation
# with Yarn
yarn add @tiptap/extension-collaboration-annotation
```
This extension requires the [`Collaboration`](/api/extensions/collaboration) extension.
## Settings
| Option | Type | Default | Description |
| -------- | -------- | ----------- | ---------------------------------------------------------------------------------- |
| document | `Object` | `null` | An initialized Y.js document. |
| field | `String` | `'default'` | Name of a Y.js map, can be changed to sync multiple fields with one Y.js document. |
| map | `Object` | `null` | A raw Y.js map, can be used instead of `document` and `field`. |
## Commands
| Command | Parameters | Description |
| ---------------- | ---------- | ------------------------------------------------------------------------- |
| addAnnotation | data | Adds an annotation to the current selection, takes a string or an object. |
| updateAnnotation | id, data | Update the data that’s associated with an annotation. |
| deleteAnnotation | id | Remove an annotation. |
<!-- ## Source code
[packages/extension-collaboration-annotation/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-collaboration-annotation/) -->
## Usage
<tiptap-demo name="Experiments/CollaborationAnnotation"></tiptap-demo>

8
docs/src/docPages/experiments/global-drag-handle.md
View File

@@ -1,8 +0,0 @@
# GlobalDragHandle
⚠️ Experiment
## Issues
* We’re working on a better, more solid implementation. :) Give us some more time, and please, don’t ask when it’s ready. The best thing to speed up the development is to [sponsor our work](/sponsor) on GitHub.
<tiptap-demo name="Experiments/GlobalDragHandle"></tiptap-demo>