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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Make your text bold and let it stand out.
|
||||
---
|
||||
|
||||
# Bold
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-bold)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-bold?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Developers love to add some inline code to their texts.
|
||||
---
|
||||
|
||||
# Code
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-code)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-code?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Make it look nerdier with some colorful text highlights.
|
||||
---
|
||||
|
||||
# Highlight
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-highlight)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-highlight?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Helps to emphasize your text, doesn’t bring you closer to Italy though.
|
||||
---
|
||||
|
||||
# Italic
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-italic)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-italic?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Link it, link it good, link it real good (and don’t forget the href).
|
||||
---
|
||||
|
||||
# Link
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-link)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-link?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Cut through the words you wrote, if you’re too afraid to delete it.
|
||||
---
|
||||
|
||||
# Strike
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-strike)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-strike?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Write slightly below the the normal line, to show you’re unique.
|
||||
---
|
||||
|
||||
# Subscript
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-subscript)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-subscript?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Write slightly above the the normal line, to show you’re just next level.
|
||||
---
|
||||
|
||||
# Superscript
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-superscript)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-superscript?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Useless extension, just adds <span> tags (required by other extensions though).
|
||||
---
|
||||
|
||||
# TextStyle
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-text-style)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-text-style?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Add a line below your text to make it look more … underlined.
|
||||
---
|
||||
|
||||
# Underline
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-underline)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-underline?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Quoting other people lets you look clever.
|
||||
---
|
||||
|
||||
# Blockquote
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-blockquote)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-blockquote?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Everything looks more serious with a few bullet points.
|
||||
---
|
||||
|
||||
# BulletList
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-bullet-list)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-bullet-list?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Add some colorful syntax highlighting to your code blocks.
|
||||
---
|
||||
|
||||
# CodeBlockLowlight
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-code-block-lowlight)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-code-block-lowlight?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: The least code the better, but sometimes you need multiple lines of it.
|
||||
---
|
||||
|
||||
# CodeBlock
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-code-block)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-code-block?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "Everyone needs it, nobody talks about it: the Document extension."
|
||||
---
|
||||
|
||||
# Document
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-document)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-document?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "Not ready yet. :construction:"
|
||||
---
|
||||
|
||||
# Emoji
|
||||
|
||||
## Support for emojis
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Sometimes we all need a break, even it’s just a line break.
|
||||
---
|
||||
|
||||
# HardBreak
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-hard-break)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-hard-break?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "#notdone #procrastinate"
|
||||
---
|
||||
|
||||
# Hashtag
|
||||
|
||||
:::pro Fund the development ♥
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Structure the content with headings (comes with 6 different levels or less).
|
||||
---
|
||||
|
||||
# Heading
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-heading)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-heading?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Separate what needs to be separated, but use it wisely.
|
||||
---
|
||||
|
||||
# HorizontalRule
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-horizontal-rule)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-horizontal-rule?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Add an image (but a beautiful one), when words aren’t enough.
|
||||
---
|
||||
|
||||
# Image
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-image)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-image?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Doesn’t care if it’s part of a bullet list or an ordered list.
|
||||
---
|
||||
|
||||
# ListItem
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-list-item)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-list-item?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Ping all your people @marijn @kevin
|
||||
---
|
||||
|
||||
# Mention
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-mention)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-mention?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: If a bullet list doesn’t look serious enough, put some numbers in front of it.
|
||||
---
|
||||
|
||||
# OrderedList
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-ordered-list)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-ordered-list?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Mom, look! I wrote a paragraph in the Internet.
|
||||
---
|
||||
|
||||
# Paragraph
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-paragraph)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-paragraph?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "It’s useless without all its other table friends: the table cell."
|
||||
---
|
||||
|
||||
# TableCell
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-table-cell)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-table-cell?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "Tables don’t require a header, but let’s be honest: It looks better with it."
|
||||
---
|
||||
|
||||
# TableHeader
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-table-header)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-table-header?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: "The perfect middle ground between a table and a table cell."
|
||||
---
|
||||
|
||||
# TableRow
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-table-row)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-table-row?minimal=true)
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---
|
||||
description: You’re working on something really serious if you need tables inside a text editor.
|
||||
tableOfContents: true
|
||||
---
|
||||
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: The actually task, without it the task list would be nothing.
|
||||
---
|
||||
|
||||
# TaskItem
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-task-item)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-task-item?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: Adds support for tasks (doesn’t make sure you actually complete them though).
|
||||
---
|
||||
|
||||
# TaskList
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-task-list)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-task-list?minimal=true)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
description: No text editor without text, so better make sure to install that one.
|
||||
---
|
||||
|
||||
# Text
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-text)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-text?minimal=true)
|
||||
|
||||
Reference in New Issue
Block a user