docs: update content

2024-11-25 21:12:20 +08:00 · 2020-12-03 17:05:22 +01:00 · 2020-12-03 17:05:22 +01:00 · 7c64c41084
commit 7c64c41084
parent e1fe9b4d50
14 changed files with 66 additions and 33 deletions
--- a/docs/src/docPages/api/extensions/collaboration-cursor.md
+++ b/docs/src/docPages/api/extensions/collaboration-cursor.md
@ -28,9 +28,9 @@ yarn add @tiptap/extension-collaboration-cursor
 | render   | `Function` | …                             | A render function for the cursor, look at [the extension source code](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration-cursor/) for an example. |

 ## Commands
-| Command | Parameters    | Description                                                              |
-| ------- | ------------- | ------------------------------------------------------------------------ |
-| user    | name<br>color | The name of the current user.<br>The color of the current user’s cursor. |
+| Command | Parameters | Description                                                                                      |
+| ------- | ---------- | ------------------------------------------------------------------------------------------------ |
+| user    | attributes | An object with the attributes of the current user, by default it expects a `name` and a `color`. |

 ## Source code
 [packages/extension-collaboration-cursor/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration-cursor/)
--- a/docs/src/docPages/api/extensions/suggestion.md
+++ b/docs/src/docPages/api/extensions/suggestion.md
@ -5,3 +5,5 @@ TODO
 - mentions
 - hashtags
 - emojis
+- snippets
+- variables
--- a/docs/src/docPages/api/marks.md
+++ b/docs/src/docPages/api/marks.md
@ -5,11 +5,13 @@
 ## Introduction

 ## List of supported marks
-| Title                             | Default Extension | Source Code                                                                                 |
-| --------------------------------- | ----------------- | ------------------------------------------------------------------------------------------- |
-| [Bold](/api/marks/bold)           | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)      |
-| [Code](/api/marks/code)           | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/)      |
-| [Italic](/api/marks/italic)       | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/)    |
-| [Link](/api/marks/link)           | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/)      |
-| [Strike](/api/marks/strike)       | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/)    |
-| [Underline](/api/marks/underline) | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) |
+| Title                              | Default Extension | Source Code                                                                                  |
+| ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- |
+| [Bold](/api/marks/bold)            | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)       |
+| [Code](/api/marks/code)            | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/)       |
+| [Highlight](/api/marks/highlight)  | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-highlight/)  |
+| [Italic](/api/marks/italic)        | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/)     |
+| [Link](/api/marks/link)            | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/)       |
+| [Strike](/api/marks/strike)        | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/)     |
+| [TextStyle](/api/marks/text-style) | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text-style/) |
+| [Underline](/api/marks/underline)  | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/)  |
--- a/docs/src/docPages/api/marks/bold.md
+++ b/docs/src/docPages/api/marks/bold.md
@ -22,9 +22,11 @@ yarn add @tiptap/extension-bold
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command | Parameters | Description     |
-| ------- | ---------- | --------------- |
-| bold    | —          | Mark text bold. |
+| Command    | Parameters | Description        |
+| ---------- | ---------- | ------------------ |
+| setBold    | —          | Mark text as bold. |
+| toggleBold | —          | Toggle bold mark.  |
+| unsetBold  | —          | Remove bold mark.  |

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`B`
--- a/docs/src/docPages/api/marks/code.md
+++ b/docs/src/docPages/api/marks/code.md
@ -18,9 +18,11 @@ yarn add @tiptap/extension-code
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command | Parameters | Description               |
-| ------- | ---------- | ------------------------- |
-| code    | —          | Mark text as inline code. |
+| Command    | Parameters | Description               |
+| ---------- | ---------- | ------------------------- |
+| setCode    | —          | Mark text as inline code. |
+| toggleCode | —          | Toggle inline code mark.  |
+| unsetCode  | —          | Remove inline code mark.  |

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`E`
--- a/docs/src/docPages/api/marks/highlight.md
+++ b/docs/src/docPages/api/marks/highlight.md
@ -18,9 +18,11 @@ yarn add @tiptap/extension-highlight
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command   | Options | Description                                                 |
-| --------- | ------- | ----------------------------------------------------------- |
-| highlight | color   | Mark text as highlighted, optionally pass a specific color. |
+| Command         | Options            | Description               |
+| --------------- | ------------------ | ------------------------- |
+| setHighlight    | `color` (optional) | Mark text as highlighted. |
+| toggleHighlight | `color` (optional) | Toggle a text highlight.  |
+| unsetHighlight  | —                  | Removes the highlight.    |

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`Shift`&nbsp;`H`
--- a/docs/src/docPages/api/marks/italic.md
+++ b/docs/src/docPages/api/marks/italic.md
@ -22,9 +22,12 @@ yarn add @tiptap/extension-italic
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command | Parameters | Description       |
-| ------- | ---------- | ----------------- |
-| italic  | —          | Mark text italic. |
+| Command      | Parameters | Description          |
+| ------------ | ---------- | -------------------- |
+| setItalic    | —          | Mark text as italic. |
+| toggleItalic | —          | Toggle italic mark.  |
+| unsetItalic  | —          | Remove italic mark.  |
+

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`I`
--- a/docs/src/docPages/api/marks/link.md
+++ b/docs/src/docPages/api/marks/link.md
@ -21,9 +21,11 @@ yarn add @tiptap/extension-link
 | openOnClick    | `Boolean` | `true`                                                      | If enabled, links will be opened on click.                            |

 ## Commands
-| Command | Parameters     | Description                                                 |
-| ------- | -------------- | ----------------------------------------------------------- |
-| link    | href<br>target | Link the selected text. Removes a link, if `href` is empty. |
+| Command    | Parameters         | Description                                  |
+| ---------- | ------------------ | -------------------------------------------- |
+| setLink    | `href`<br>`target` | Link the selected text.                      |
+| toggleLink | `href`<br>`target` | Add or remove a link from the selected text. |
+| unsetLink  | –                  | Removes a link.                              |

 ## Keyboard shortcuts
 :::warning Doesn’t have a keyboard shortcut
--- a/docs/src/docPages/api/marks/strike.md
+++ b/docs/src/docPages/api/marks/strike.md
@ -22,9 +22,11 @@ yarn add @tiptap/extension-strike
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command | Parameters | Description                 |
-| ------- | ---------- | --------------------------- |
-| strike  | —          | Mark text as strikethrough. |
+| Command      | Parameters | Description           |
+| ------------ | ---------- | --------------------- |
+| setStrike    | —          | Mark text as striked. |
+| toggleStrike | —          | Toggle strike mark.   |
+| unsetStrike  | —          | Remove strike mark.   |

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`Shift`&nbsp;`X`
--- a/docs/src/docPages/api/marks/underline.md
+++ b/docs/src/docPages/api/marks/underline.md
@ -22,9 +22,11 @@ yarn add @tiptap/extension-underline
 | HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

 ## Commands
-| Command   | Parameters | Description              |
-| --------- | ---------- | ------------------------ |
-| underline | —          | Mark text as underlined. |
+| Command         | Parameters | Description              |
+| --------------- | ---------- | ------------------------ |
+| setUnderline    | —          | Mark text as underlined. |
+| toggleUnderline | —          | Toggle underline mark.   |
+| unsetUnderline  | —          | Remove underline mark.   |

 ## Keyboard shortcuts
 * Windows/Linux: `Control`&nbsp;`U`
--- a/docs/src/docPages/api/nodes.md
+++ b/docs/src/docPages/api/nodes.md
@ -18,6 +18,6 @@
 | [ListItem](/api/nodes/list-item)             | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/)       |
 | [OrderedList](/api/nodes/ordered-list)       | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/)    |
 | [Paragraph](/api/nodes/paragraph)            | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/)       |
-| [TaskItem](/api/nodes/task-item)             | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-item/)       |
 | [TaskList](/api/nodes/task-list)             | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-list/)       |
+| [TaskItem](/api/nodes/task-item)             | –                 | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-item/)       |
 | [Text](/api/nodes/text)                      | Yes               | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/)            |
--- a/docs/src/docPages/api/nodes/table-cell.md
+++ b/docs/src/docPages/api/nodes/table-cell.md
@ -0,0 +1,3 @@
+# TableCell
+
+ TODO
--- a/docs/src/docPages/api/nodes/table-row.md
+++ b/docs/src/docPages/api/nodes/table-row.md
@ -0,0 +1,3 @@
+# TableRow
+
+ TODO
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@ -97,6 +97,14 @@
          link: /api/nodes/table
          draft: true
          pro: true
+        - title: TableRow
+          link: /api/nodes/table-row
+          draft: true
+          pro: true
+        - title: TableCell
+          link: /api/nodes/table-cell
+          draft: true
+          pro: true
        - title: TaskList
          link: /api/nodes/task-list
        - title: TaskItem