docs: add descriptions to all extensions
This commit is contained in:
Hans Pagel
@@ -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