remove gridsome
This commit is contained in:
46
docs/experiments/collaboration-annotation.md
Normal file
46
docs/experiments/collaboration-annotation.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# CollaborationAnnotation
|
||||
<!-- [](https://www.npmjs.com/package/@tiptap/extension-collaboration-annotation)
|
||||
[](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/experiments/commands.md
Normal file
8
docs/experiments/commands.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Commands
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
## Issues
|
||||
* It’s fine to use, just don’t send bug reports, PRs or anything else. We’ll just need some time to publish that as an official extension.
|
||||
|
||||
<tiptap-demo name="Experiments/Commands"></tiptap-demo>
|
||||
8
docs/experiments/details.md
Normal file
8
docs/experiments/details.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Details
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
## Issues
|
||||
* Nested lists cause trouble
|
||||
|
||||
<tiptap-demo name="Experiments/Details"></tiptap-demo>
|
||||
8
docs/experiments/embeds.md
Normal file
8
docs/experiments/embeds.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Embeds
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
## Issues
|
||||
* Oh man, building a really good iframe/embed extension will take some time. The best thing to speed up the development is to [sponsor our work](/sponsor) on GitHub.
|
||||
|
||||
<tiptap-demo name="Experiments/Embeds"></tiptap-demo>
|
||||
12
docs/experiments/figure.md
Normal file
12
docs/experiments/figure.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Figure
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
## Related links
|
||||
* https://github.com/ueberdosis/tiptap/issues/573#issuecomment-730122427
|
||||
* https://discuss.prosemirror.net/t/figure-and-editable-caption/462/5
|
||||
|
||||
## Issues
|
||||
* The current implementation works with images only.
|
||||
|
||||
<tiptap-demo name="Experiments/Figure"></tiptap-demo>
|
||||
5
docs/experiments/generic-figure.md
Normal file
5
docs/experiments/generic-figure.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# GenericFigure
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
<tiptap-demo name="Experiments/GenericFigure"></tiptap-demo>
|
||||
8
docs/experiments/global-drag-handle.md
Normal file
8
docs/experiments/global-drag-handle.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# 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>
|
||||
10
docs/experiments/linter.md
Normal file
10
docs/experiments/linter.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Linter
|
||||
|
||||
⚠️ Experiment, currently not supported or maintained
|
||||
|
||||
Linter can be used to check the content as per your wish and highlight it to the user. Linter extension can have multiple plugins for each task you want to achieve.
|
||||
|
||||
## Issues
|
||||
* There is no decoration API in tiptap, that’s why this is a lot of ProseMirror work. Before we’ll publish that example, we’d need to find a few ways to make it more tiptap-like. For example, it would be great to use Vue/React components for the widget.
|
||||
|
||||
<tiptap-demo name="Experiments/Linter"></tiptap-demo>
|
||||
5
docs/experiments/multiple-editors.md
Normal file
5
docs/experiments/multiple-editors.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Multiple editors
|
||||
|
||||
The following example has three different instances of tiptap. The first is configured to have a single paragraph of text, the second to have a task list and the third to have text. All of them are stored in a single Y.js document, which can be synced in real-time with other users.
|
||||
|
||||
<tiptap-demo name="Experiments/MultipleEditors"></tiptap-demo>
|
||||
8
docs/experiments/trailing-node.md
Normal file
8
docs/experiments/trailing-node.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Trailing node
|
||||
|
||||
⚠️ Experiment
|
||||
|
||||
## Issues
|
||||
* This implementation adds an actual node. It’d be great to use a decoration for that use case, so the document isn’t modified.
|
||||
|
||||
<tiptap-demo name="Experiments/TrailingNode"></tiptap-demo>
|
||||
Reference in New Issue
Block a user