docs: add descriptions to all extensions
This commit is contained in:
Hans Pagel
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Add a toolbar that pops up above the text to apply inline formatting easily.
|
||||
---
|
||||
|
||||
# Bubble Menu
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-bubble-menu)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-bubble-menu?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Limit the number of characters in your editor, or at least count them.
|
||||
---
|
||||
|
||||
# CharacterCount
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-character-count)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-character-count?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: See other user’s cursors and their name while they type.
|
||||
---
|
||||
|
||||
# CollaborationCursor
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-collaboration-cursor)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-collaboration-cursor?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Collaborative text editing can be fricking complex, so we made it different.
|
||||
---
|
||||
|
||||
# Collaboration
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-collaboration)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-collaboration?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Add text color support to your editor (comes with unlimited colors).
|
||||
---
|
||||
|
||||
# Color
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-color)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-color?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Adds a cursor when something is dragged inside the editor.
|
||||
---
|
||||
|
||||
# Dropcursor
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-dropcursor)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-dropcursor?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Make a toolbar appear automagically on empty lines.
|
||||
---
|
||||
|
||||
# Floating Menu
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-floating-menu)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-floating-menu?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Keep track of where the cursor is, and let the user know you know it.
|
||||
---
|
||||
|
||||
# Focus
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-focus)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-focus?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Don’t let your users use Comic Sans MS, but let them use all other fonts.
|
||||
---
|
||||
|
||||
# FontFamily
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-font-family)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-font-family?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: The gapcursor makes sure the cursor doesn’t get stuck … in a gap.
|
||||
---
|
||||
|
||||
# Gapcursor
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-gapcursor)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-gapcursor?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: If I could just go back and make everything undone … you can.
|
||||
---
|
||||
|
||||
# History
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-history)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-history?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Configure a helpful placeholder to fill the emptyness.
|
||||
---
|
||||
|
||||
# Placeholder
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-placeholder)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-placeholder?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: All the popular extensions in a single extension, doesn’t get much better than this.
|
||||
---
|
||||
|
||||
# StarterKit
|
||||
[](https://www.npmjs.com/package/@tiptap/starter-kit)
|
||||
[](https://npmcharts.com/compare/@tiptap/starter-kit?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Left, right, center, whatever! Align the text however you like.
|
||||
---
|
||||
|
||||
# TextAlign
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-text-align)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-text-align?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: The typography smart ass for your editor, replaces everything that’s wrong.
|
||||
---
|
||||
|
||||
# Typography
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-typography)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-typography?minimal=true)
|
||||
|
||||
Reference in New Issue
Block a user