diff --git a/docs/src/docPages/api/extensions/collaboration-cursor.md b/docs/src/docPages/api/extensions/collaboration-cursor.md index 9927d8df0..6b1b4eba9 100644 --- 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
color | The name of the current user.
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/) diff --git a/docs/src/docPages/api/extensions/suggestion.md b/docs/src/docPages/api/extensions/suggestion.md index af95f2987..74ec6056c 100644 --- 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 diff --git a/docs/src/docPages/api/marks.md b/docs/src/docPages/api/marks.md index 31acae585..7a58c3d67 100644 --- 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/) | diff --git a/docs/src/docPages/api/marks/bold.md b/docs/src/docPages/api/marks/bold.md index 003bd3ff7..a927a5a82 100644 --- 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` `B` diff --git a/docs/src/docPages/api/marks/code.md b/docs/src/docPages/api/marks/code.md index 236d3cc64..be98f271b 100644 --- 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` `E` diff --git a/docs/src/docPages/api/marks/highlight.md b/docs/src/docPages/api/marks/highlight.md index c839118b9..1d98c4340 100644 --- 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` `Shift` `H` diff --git a/docs/src/docPages/api/marks/italic.md b/docs/src/docPages/api/marks/italic.md index 032c09ad3..3ece3ec9b 100644 --- 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` `I` diff --git a/docs/src/docPages/api/marks/link.md b/docs/src/docPages/api/marks/link.md index a438ef443..180e093d2 100644 --- 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
target | Link the selected text. Removes a link, if `href` is empty. | +| Command | Parameters | Description | +| ---------- | ------------------ | -------------------------------------------- | +| setLink | `href`
`target` | Link the selected text. | +| toggleLink | `href`
`target` | Add or remove a link from the selected text. | +| unsetLink | – | Removes a link. | ## Keyboard shortcuts :::warning Doesn’t have a keyboard shortcut diff --git a/docs/src/docPages/api/marks/strike.md b/docs/src/docPages/api/marks/strike.md index 74a75fcbc..302562a96 100644 --- 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` `Shift` `X` diff --git a/docs/src/docPages/api/marks/underline.md b/docs/src/docPages/api/marks/underline.md index f685936db..560ad7117 100644 --- 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` `U` diff --git a/docs/src/docPages/api/nodes.md b/docs/src/docPages/api/nodes.md index f7c12b50d..451f465c6 100644 --- 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/) | diff --git a/docs/src/docPages/api/nodes/table-cell.md b/docs/src/docPages/api/nodes/table-cell.md new file mode 100644 index 000000000..7aca16bf0 --- /dev/null +++ b/docs/src/docPages/api/nodes/table-cell.md @@ -0,0 +1,3 @@ +# TableCell + + TODO diff --git a/docs/src/docPages/api/nodes/table-row.md b/docs/src/docPages/api/nodes/table-row.md new file mode 100644 index 000000000..e234309f3 --- /dev/null +++ b/docs/src/docPages/api/nodes/table-row.md @@ -0,0 +1,3 @@ +# TableRow + + TODO diff --git a/docs/src/links.yaml b/docs/src/links.yaml index fb119b453..febe2195d 100644 --- 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