mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-06-11 11:45:15 +08:00
docs: add icons for extensions
This commit is contained in:
Martin Kriegeskorte
parent
9948e2499a
commit
0a5d4b6658
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Add a toolbar that pops up above the text to apply inline formatting easily.
|
description: Add a toolbar that pops up above the text to apply inline formatting easily.
|
||||||
|
icon: chat-2-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bubble Menu
|
# Bubble Menu
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: See other user’s cursors and their name while they type.
|
description: See other user’s cursors and their name while they type.
|
||||||
|
icon: account-pin-circle-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# CollaborationCursor
|
# CollaborationCursor
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Collaborative text editing can be fricking complex, so we made it different.
|
description: Collaborative text editing can be fricking complex, so we made it different.
|
||||||
|
icon: user-voice-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Collaboration
|
# Collaboration
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Add text color support to your editor (comes with unlimited colors).
|
description: Add text color support to your editor (comes with unlimited colors).
|
||||||
|
icon: paint-brush-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Color
|
# Color
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Adds a cursor when something is dragged inside the editor.
|
description: Adds a cursor when something is dragged inside the editor.
|
||||||
|
icon: drag-drop-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Dropcursor
|
# Dropcursor
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Make a toolbar appear automagically on empty lines.
|
description: Make a toolbar appear automagically on empty lines.
|
||||||
|
icon: menu-4-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Floating Menu
|
# Floating Menu
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: The gapcursor makes sure the cursor doesn’t get stuck … in a gap.
|
description: The gapcursor makes sure the cursor doesn’t get stuck … in a gap.
|
||||||
|
icon: space
|
||||||
---
|
---
|
||||||
|
|
||||||
# Gapcursor
|
# Gapcursor
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: If I could just go back and make everything undone … you can.
|
description: If I could just go back and make everything undone … you can.
|
||||||
|
icon: history-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# History
|
# History
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: All the popular extensions in a single extension, doesn’t get much better than this.
|
description: All the popular extensions in a single extension, doesn’t get much better than this.
|
||||||
|
icon: star-smile-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# StarterKit
|
# StarterKit
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Left, right, center, whatever! Align the text however you like.
|
description: Left, right, center, whatever! Align the text however you like.
|
||||||
|
icon: align-left
|
||||||
---
|
---
|
||||||
|
|
||||||
# TextAlign
|
# TextAlign
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: The typography smart ass for your editor, replaces everything that’s wrong.
|
description: The typography smart ass for your editor, replaces everything that’s wrong.
|
||||||
|
icon: text
|
||||||
---
|
---
|
||||||
|
|
||||||
# Typography
|
# Typography
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Make your text bold and let it stand out.
|
description: Make your text bold and let it stand out.
|
||||||
|
icon: bold
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bold
|
# Bold
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Developers love to add some inline code to their texts.
|
description: Developers love to add some inline code to their texts.
|
||||||
|
icon: code-view
|
||||||
---
|
---
|
||||||
|
|
||||||
# Code
|
# Code
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Make it look nerdier with some colorful text highlights.
|
description: Make it look nerdier with some colorful text highlights.
|
||||||
|
icon: mark-pen-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Highlight
|
# Highlight
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Helps to emphasize your text, doesn’t bring you closer to Italy though.
|
description: Helps to emphasize your text, doesn’t bring you closer to Italy though.
|
||||||
|
icon: italic
|
||||||
---
|
---
|
||||||
|
|
||||||
# Italic
|
# Italic
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Link it, link it good, link it real good (and don’t forget the href).
|
description: Link it, link it good, link it real good (and don’t forget the href).
|
||||||
|
icon: link
|
||||||
---
|
---
|
||||||
|
|
||||||
# Link
|
# Link
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Cut through the words you wrote, if you’re too afraid to delete it.
|
description: Cut through the words you wrote, if you’re too afraid to delete it.
|
||||||
|
icon: strikethrough
|
||||||
---
|
---
|
||||||
|
|
||||||
# Strike
|
# Strike
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Write slightly below the normal line, to show you’re unique.
|
description: Write slightly below the normal line, to show you’re unique.
|
||||||
|
icon: subscript
|
||||||
---
|
---
|
||||||
|
|
||||||
# Subscript
|
# Subscript
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Write slightly above the normal line, to show you’re just next level.
|
description: Write slightly above the normal line, to show you’re just next level.
|
||||||
|
icon: superscript
|
||||||
---
|
---
|
||||||
|
|
||||||
# Superscript
|
# Superscript
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Useless extension, just adds <span> tags (required by other extensions though).
|
description: Useless extension, just adds <span> tags (required by other extensions though).
|
||||||
|
icon: text
|
||||||
---
|
---
|
||||||
|
|
||||||
# TextStyle
|
# TextStyle
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Add a line below your text to make it look more … underlined.
|
description: Add a line below your text to make it look more … underlined.
|
||||||
|
icon: underline
|
||||||
---
|
---
|
||||||
|
|
||||||
# Underline
|
# Underline
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Quoting other people lets you look clever.
|
description: Quoting other people lets you look clever.
|
||||||
|
icon: double-quotes-l
|
||||||
---
|
---
|
||||||
|
|
||||||
# Blockquote
|
# Blockquote
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Everything looks more serious with a few bullet points.
|
description: Everything looks more serious with a few bullet points.
|
||||||
|
icon: list-unordered
|
||||||
---
|
---
|
||||||
|
|
||||||
# BulletList
|
# BulletList
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Add some colorful syntax highlighting to your code blocks.
|
description: Add some colorful syntax highlighting to your code blocks.
|
||||||
|
icon: terminal-box-fill
|
||||||
---
|
---
|
||||||
|
|
||||||
# CodeBlockLowlight
|
# CodeBlockLowlight
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: The least code the better, but sometimes you need multiple lines of it.
|
description: The least code the better, but sometimes you need multiple lines of it.
|
||||||
|
icon: terminal-box-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# CodeBlock
|
# CodeBlock
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "Everyone needs it, nobody talks about it: the Document extension."
|
description: "Everyone needs it, nobody talks about it: the Document extension."
|
||||||
|
icon: file-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Document
|
# Document
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "Not ready yet. :construction:"
|
description: "Not ready yet. :construction:"
|
||||||
|
icon: emotion-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Emoji
|
# Emoji
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Sometimes we all need a break, even if it’s just a line break.
|
description: Sometimes we all need a break, even if it’s just a line break.
|
||||||
|
icon: text-wrap
|
||||||
---
|
---
|
||||||
|
|
||||||
# HardBreak
|
# HardBreak
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "#notdone #procrastinate"
|
description: "#notdone #procrastinate"
|
||||||
|
icon: hashtag
|
||||||
---
|
---
|
||||||
|
|
||||||
# Hashtag
|
# Hashtag
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Structure the content with headings (comes with 6 different levels or less).
|
description: Structure the content with headings (comes with 6 different levels or less).
|
||||||
|
icon: h-1
|
||||||
---
|
---
|
||||||
|
|
||||||
# Heading
|
# Heading
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Separate what needs to be separated, but use it wisely.
|
description: Separate what needs to be separated, but use it wisely.
|
||||||
|
icon: separator
|
||||||
---
|
---
|
||||||
|
|
||||||
# HorizontalRule
|
# HorizontalRule
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Add an image (but a beautiful one), when words aren’t enough.
|
description: Add an image (but a beautiful one), when words aren’t enough.
|
||||||
|
icon: image-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Image
|
# Image
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Doesn’t care if it’s part of a bullet list or an ordered list.
|
description: Doesn’t care if it’s part of a bullet list or an ordered list.
|
||||||
|
icon: list-unordered
|
||||||
---
|
---
|
||||||
|
|
||||||
# ListItem
|
# ListItem
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Ping all your people @marijn @kevin
|
description: Ping all your people @marijn @kevin
|
||||||
|
icon: at-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# Mention
|
# Mention
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: If a bullet list doesn’t look serious enough, put some numbers in front of it.
|
description: If a bullet list doesn’t look serious enough, put some numbers in front of it.
|
||||||
|
icon: list-ordered
|
||||||
---
|
---
|
||||||
|
|
||||||
# OrderedList
|
# OrderedList
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Mom, look! I wrote a paragraph in the Internet.
|
description: Mom, look! I wrote a paragraph in the Internet.
|
||||||
|
icon: paragraph
|
||||||
---
|
---
|
||||||
|
|
||||||
# Paragraph
|
# Paragraph
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "It’s useless without all its other table friends: the table cell."
|
description: "It’s useless without all its other table friends: the table cell."
|
||||||
|
icon: table-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# TableCell
|
# TableCell
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "Tables don’t require a header, but let’s be honest: It looks better with it."
|
description: "Tables don’t require a header, but let’s be honest: It looks better with it."
|
||||||
|
icon: table-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# TableHeader
|
# TableHeader
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: "The perfect middle ground between a table and a table cell."
|
description: "The perfect middle ground between a table and a table cell."
|
||||||
|
icon: table-line
|
||||||
---
|
---
|
||||||
|
|
||||||
# TableRow
|
# TableRow
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: You’re working on something really serious if you need tables inside a text editor.
|
description: You’re working on something really serious if you need tables inside a text editor.
|
||||||
|
icon: table-line
|
||||||
tableOfContents: true
|
tableOfContents: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: The actually task, without it the task list would be nothing.
|
description: The actually task, without it the task list would be nothing.
|
||||||
|
icon: list-check
|
||||||
---
|
---
|
||||||
|
|
||||||
# TaskItem
|
# TaskItem
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: Adds support for tasks (doesn’t make sure you actually complete them though).
|
description: Adds support for tasks (doesn’t make sure you actually complete them though).
|
||||||
|
icon: list-check
|
||||||
---
|
---
|
||||||
|
|
||||||
# TaskList
|
# TaskList
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
description: No text editor without text, so better make sure to install that one.
|
description: No text editor without text, so better make sure to install that one.
|
||||||
|
icon: text
|
||||||
---
|
---
|
||||||
|
|
||||||
# Text
|
# Text
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user