From 3c176f6e3e92c56f40c2500a1ad9deab463faace Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 16 Sep 2021 14:31:54 +0200 Subject: [PATCH] docs: clean up --- docs/src/docPages/experiments.md | 2 - .../experiments/collaboration-annotation.md | 46 ------------------- .../experiments/global-drag-handle.md | 8 ---- 3 files changed, 56 deletions(-) delete mode 100644 docs/src/docPages/experiments/collaboration-annotation.md delete mode 100644 docs/src/docPages/experiments/global-drag-handle.md diff --git a/docs/src/docPages/experiments.md b/docs/src/docPages/experiments.md index 7b665c3c..7de117e3 100644 --- a/docs/src/docPages/experiments.md +++ b/docs/src/docPages/experiments.md @@ -4,13 +4,11 @@ Congratulations! You’ve found our playground with a list of experiments. Be aw ## Experimental examples * [Linter](/experiments/linter) * [Content of multiple editors in a single Y.js](/experiments/multiple-editors) -* [Global drag handle](/experiments/global-drag-handle) * [Generic Figure](/experiments/generic-figure) ## Experimental extensions * [@tiptap/extension-command-menu](/experiments/commands) * [@tiptap/extension-iframe](/experiments/embeds) * [@tiptap/extension-toggle-list](/experiments/details) -* [@tiptap/extension-collaboration-annotation](/experiments/collaboration-annotation) * [@tiptap/extension-trailing-node](/experiments/trailing-node) * [@tiptap/extension-figure](/experiments/figure) diff --git a/docs/src/docPages/experiments/collaboration-annotation.md b/docs/src/docPages/experiments/collaboration-annotation.md deleted file mode 100644 index 51b1ef85..00000000 --- a/docs/src/docPages/experiments/collaboration-annotation.md +++ /dev/null @@ -1,46 +0,0 @@ -# CollaborationAnnotation - - -⚠️ 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. - - - -## 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. | - - - -## Usage - diff --git a/docs/src/docPages/experiments/global-drag-handle.md b/docs/src/docPages/experiments/global-drag-handle.md deleted file mode 100644 index ce152ea6..00000000 --- a/docs/src/docPages/experiments/global-drag-handle.md +++ /dev/null @@ -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. - -