docs: clean up experiments, add some notes here and there

This commit is contained in:
Hans Pagel
2021-07-10 23:04:05 +02:00
parent 5301e6f3d4
commit 2019eb6e20
11 changed files with 28 additions and 155 deletions

View File

@@ -1,14 +1,15 @@
# Experiments
Congratulations! Youve found our playground with a list of experiments. Be aware that nothing here is ready to use. Feel free to play around, but please, dont open an issue for a bug youve found here or send pull requests. :-)
## New
## Experimental examples
* [Linter](/experiments/linter)
* [Multiple editors](/experiments/multiple-editors)
* [Content of multiple editors in a single Y.js](/experiments/multiple-editors)
* [Global drag handle](/experiments/global-drag-handle)
* [@tiptap/extension-slash-command?](/experiments/commands)
* [@tiptap/extension-iframe?](/experiments/embeds)
* [@tiptap/extension-toggle-list?](/experiments/details)
## 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-word-break](/experiments/word-break)
* [@tiptap/extension-trailing-node](/experiments/trailing-node)
* [@tiptap/extension-figure](/experiments/figure)

View File

@@ -2,4 +2,7 @@
⚠️ Experiment
## Issues
* Its fine to use, just dont send bug reports, PRs or anything else. Well just need some time to publish that as an official extension.
<demo name="Experiments/Commands" />

View File

@@ -2,4 +2,7 @@
⚠️ Experiment
## Issues
* Nested lists cause trouble
<demo name="Experiments/Details" />

View File

@@ -2,4 +2,7 @@
⚠️ 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.
<demo name="Experiments/Embeds" />

View File

@@ -2,12 +2,11 @@
⚠️ Experiment
## Tasks
* Build commands to wrap an image into a figure + figcaption?
* Build commands to unrwap figure + figcaption to an image?
## 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.
<demo name="Experiments/Figure" />

View File

@@ -2,4 +2,7 @@
⚠️ Experiment
## Issues
* Were working on a better, more solid implementation. :) Give us some more time, and please, dont ask when its ready. The best thing to speed up the development is to [sponsor our work](/sponsor) on GitHub.
<demo name="Experiments/GlobalDragHandle" />

View File

@@ -2,4 +2,7 @@
⚠️ Experiment
## Issues
* There is no decoration API in tiptap, thats why this is a lot of ProseMirror work. Before well publish that example, wed 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.
<demo name="Experiments/Linter" />

View File

@@ -2,4 +2,7 @@
⚠️ Experiment
## Issues
* This implementation adds an actual node. Itd be great to use a decoration for that use case, so the document isnt modified.
<demo name="Experiments/TrailingNode" />

View File

@@ -1,5 +0,0 @@
# Word break
⚠️ Experiment
<demo name="Experiments/WordBreak" />