diff --git a/docs/api/keyboard-shortcuts.md b/docs/api/keyboard-shortcuts.md index 5550efcfb..9d4234a4e 100644 --- a/docs/api/keyboard-shortcuts.md +++ b/docs/api/keyboard-shortcuts.md @@ -13,7 +13,7 @@ Funfact: We built a [keyboard shortcut learning app](https://mouseless.app), to Most of the core extensions register their own keyboard shortcuts. Depending on what set of extension you use, not all of the below listed keyboard shortcuts work for your editor. ### Essentials -| Action | Windows/Linux | macOS | +| Command | Windows/Linux | macOS | | ------------------------ | ------------------------------- | --------------------------- | | Copy | `Control` `C` | `Cmd` `C` | | Cut | `Control` `X` | `Cmd` `X` | @@ -24,7 +24,7 @@ Most of the core extensions register their own keyboard shortcuts. Depending on | Add a line break | `Shift` `Enter` | `Shift` `Enter` | ### Text Formatting -| Action | Windows/Linux | macOS | +| Command | Windows/Linux | macOS | | ------------- | ------------------------------- | --------------------------- | | Bold | `Control` `B` | `Cmd` `B` | | Italicize | `Control` `I` | `Cmd` `I` | @@ -34,7 +34,7 @@ Most of the core extensions register their own keyboard shortcuts. Depending on | Code | `Control` `E` | `Cmd` `E` | ### Paragraph Formatting -| Action | Windows/Linux | macOS | +| Command | Windows/Linux | macOS | | ----------------------- | ------------------------------- | --------------------------- | | Apply normal text style | `Control` `Alt` `0` | `Cmd` `Alt` `0` | | Apply heading style 1 | `Control` `Alt` `1` | `Cmd` `Alt` `1` | @@ -58,7 +58,7 @@ Most of the core extensions register their own keyboard shortcuts. Depending on ### Text Selection -| Action | Windows/Linux | macOS | +| Command | Windows/Linux | macOS | | ------------------------------------------------- | ------------------------------- | --------------------------- | | Select all | `Control` `A` | `Cmd` `A` | | Extend selection one character to left | `Shift` `←` | `Shift` `←` | diff --git a/docs/api/nodes/blockquote.md b/docs/api/nodes/blockquote.md index 13419b2e4..8c01ee93e 100644 --- a/docs/api/nodes/blockquote.md +++ b/docs/api/nodes/blockquote.md @@ -51,7 +51,7 @@ editor.commands.unsetBlockquote() ``` ## Keyboard shortcuts -| Action | Windows/Linux | macOS | +| Command | Windows/Linux | macOS | | ----------------- | ------------------------------- | --------------------------- | | Toggle Blockquote | `Control` `Shift` `B` | `Cmd` `Shift` `B` | diff --git a/docs/api/nodes/bullet-list.md b/docs/api/nodes/bullet-list.md index d9cd0a4b0..6236a9d45 100644 --- a/docs/api/nodes/bullet-list.md +++ b/docs/api/nodes/bullet-list.md @@ -28,8 +28,9 @@ This extension requires the [`ListItem`](/api/nodes/list-item) node. | bulletList | — | Toggle a bullet list. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Shift` `8` -* macOS: `Cmd` `Shift` `8` +| Command | Windows/Linux | macOS | +| ---------------- | ------------------------------- | --------------------------- | +| toggleBulletList | `Control` `Shift` `8` | `Cmd` `Shift` `8` | ## Source code [packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bullet-list/) diff --git a/docs/api/nodes/code-block-lowlight.md b/docs/api/nodes/code-block-lowlight.md index 304b5aef2..16151af60 100644 --- a/docs/api/nodes/code-block-lowlight.md +++ b/docs/api/nodes/code-block-lowlight.md @@ -27,8 +27,9 @@ yarn add @tiptap/extension-code-block-lowlight | codeBlock | — | Wrap content in a code block. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Alt` `C` -* macOS: `Cmd` `Alt` `C` +| Command | Windows/Linux | macOS | +| --------------- | ----------------------------- | ------------------------- | +| toggleCodeBlock | `Control` `Alt` `C` | `Cmd` `Alt` `C` | ## Source code [packages/extension-code-block-lowlight/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block-lowlight/) diff --git a/docs/api/nodes/code-block.md b/docs/api/nodes/code-block.md index 570fe83f6..674349c9f 100644 --- a/docs/api/nodes/code-block.md +++ b/docs/api/nodes/code-block.md @@ -31,8 +31,9 @@ yarn add @tiptap/extension-code-block | codeBlock | — | Wrap content in a code block. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Alt` `C` -* macOS: `Cmd` `Alt` `C` +| Command | Windows/Linux | macOS | +| --------------- | ----------------------------- | ------------------------- | +| toggleCodeBlock | `Control` `Alt` `C` | `Cmd` `Alt` `C` | ## Source code [packages/extension-code-block/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block/) diff --git a/docs/api/nodes/hard-break.md b/docs/api/nodes/hard-break.md index e18a322ac..19fcc8170 100644 --- a/docs/api/nodes/hard-break.md +++ b/docs/api/nodes/hard-break.md @@ -25,9 +25,9 @@ yarn add @tiptap/extension-hard-break | setHardBreak | — | Add a line break. | ## Keyboard shortcuts -* `Shift` `Enter` -* Windows/Linux: `Control` `Enter` -* macOS: `Cmd` `Enter` +| Command | Windows/Linux | macOS | +| ------------ | ---------------------------------------------- | ------------------------------------------ | +| setHardBreak | `Shift` `Enter`
`Control` `Enter` | `Shift` `Enter`
`Cmd` `Enter` | ## Source code [packages/extension-hard-break/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-hard-break/) diff --git a/docs/api/nodes/heading.md b/docs/api/nodes/heading.md index a7d3b1711..1e2bb879c 100644 --- a/docs/api/nodes/heading.md +++ b/docs/api/nodes/heading.md @@ -27,8 +27,14 @@ yarn add @tiptap/extension-heading | heading | level | Creates a heading node with the specified level. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Alt` `1-6` -* macOS: `Cmd` `Alt` `1-6` +| Command | Windows/Linux | macOS | +| --------------------------- | ----------------------------- | ------------------------- | +| toggleHeading({ level: 1 }) | `Control` `Alt` `1` | `Cmd` `Alt` `1` | +| toggleHeading({ level: 2 }) | `Control` `Alt` `2` | `Cmd` `Alt` `2` | +| toggleHeading({ level: 3 }) | `Control` `Alt` `3` | `Cmd` `Alt` `3` | +| toggleHeading({ level: 4 }) | `Control` `Alt` `4` | `Cmd` `Alt` `4` | +| toggleHeading({ level: 5 }) | `Control` `Alt` `5` | `Cmd` `Alt` `5` | +| toggleHeading({ level: 6 }) | `Control` `Alt` `6` | `Cmd` `Alt` `6` | ## Source code [packages/extension-heading/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-heading/) diff --git a/docs/api/nodes/horizontal-rule.md b/docs/api/nodes/horizontal-rule.md index b83c0acc5..108f501ae 100644 --- a/docs/api/nodes/horizontal-rule.md +++ b/docs/api/nodes/horizontal-rule.md @@ -25,9 +25,6 @@ yarn add @tiptap/extension-horizontal-rule | -------------- | ---------- | ------------------------- | | horizontalRule | — | Create a horizontal rule. | -## Keyboard shortcuts -*None* - ## Source code [packages/extension-horizontal-rule/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-horizontal-rule/) diff --git a/docs/api/nodes/list-item.md b/docs/api/nodes/list-item.md index fc2a86cb6..523dd5498 100644 --- a/docs/api/nodes/list-item.md +++ b/docs/api/nodes/list-item.md @@ -21,9 +21,11 @@ This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedL | HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. | ## Keyboard shortcuts -* New list item: `Enter` -* Sink a list item: `Tab` -* Lift a list item: `Shift` `Tab` +| Command | Windows/Linux | macOS | +| --------------- | ------------------ | ------------------ | +| splitListItem() | `Enter` | `Enter` | +| sinkListItem() | `Tab` | `Tab` | +| liftListItem() | `Shift` `Tab` | `Shift` `Tab` | ## Source code [packages/extension-list-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list-item/) diff --git a/docs/api/nodes/ordered-list.md b/docs/api/nodes/ordered-list.md index 14f1e25dc..210e646f0 100644 --- a/docs/api/nodes/ordered-list.md +++ b/docs/api/nodes/ordered-list.md @@ -28,8 +28,9 @@ This extension requires the [`ListItem`](/api/nodes/list-item) node. | orderedList | — | Toggle an ordered list. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Shift` `7` -* macOS: `Cmd` `Shift` `7` +| Command | Windows/Linux | macOS | +| ----------------- | ------------------------------- | --------------------------- | +| toggleOrderedList | `Control` `Shift` `7` | `Cmd` `Shift` `7` | ## Source code [packages/extension-ordered-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-ordered-list/) diff --git a/docs/api/nodes/paragraph.md b/docs/api/nodes/paragraph.md index cc0a14ad5..f33c2c8b5 100644 --- a/docs/api/nodes/paragraph.md +++ b/docs/api/nodes/paragraph.md @@ -28,8 +28,9 @@ yarn add @tiptap/extension-paragraph | paragraph | — | Transforms all selected nodes to paragraphs. | ## Keyboard shortcuts -* Windows & Linux: `Control` `Alt` `0` -* macOS: `Cmd` `Alt` `0` +| Command | Windows/Linux | macOS | +| -------------- | ----------------------------- | ------------------------- | +| setParagraph() | `Control` `Alt` `0` | `Cmd` `Alt` `0` | ## Source code [packages/extension-paragraph/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-paragraph/) diff --git a/docs/api/nodes/table.md b/docs/api/nodes/table.md index 97594c4f1..4980e56d5 100644 --- a/docs/api/nodes/table.md +++ b/docs/api/nodes/table.md @@ -50,7 +50,6 @@ This extension requires the [`TableRow`](/api/nodes/table-row), [`TableHeader`]( | goToPreviousCell | – | | | fixTables | – | | - ## Source code [packages/extension-table/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-table/) diff --git a/docs/api/nodes/task-item.md b/docs/api/nodes/task-item.md index 2076ec2e5..f784eeade 100644 --- a/docs/api/nodes/task-item.md +++ b/docs/api/nodes/task-item.md @@ -23,7 +23,11 @@ This extension requires the [`TaskList`](/api/nodes/task-list) node. | HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. | ## Keyboard shortcuts -* New list item: `Enter` +| Command | Windows/Linux | macOS | +| --------------- | ------------------ | ------------------ | +| splitListItem() | `Enter` | `Enter` | +| sinkListItem() | `Tab` | `Tab` | +| liftListItem() | `Shift` `Tab` | `Shift` `Tab` | ## Source code [packages/extension-task-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-item/) diff --git a/docs/api/nodes/task-list.md b/docs/api/nodes/task-list.md index 5d4ccdc04..55c1b6bb5 100644 --- a/docs/api/nodes/task-list.md +++ b/docs/api/nodes/task-list.md @@ -28,8 +28,9 @@ This extension requires the [`TaskItem`](/api/nodes/task-item) extension. | taskList | — | Toggle a task list. | ## Keyboard shortcuts -* Windows/Linux: `Control` `Shift` `9` -* macOS: `Cmd` `Shift` `9` +| Command | Windows/Linux | macOS | +| ---------------- | ------------------------------- | --------------------------- | +| toggleTaskList() | `Control` `Shift` `9` | `Cmd` `Shift` `9` | ## Source code [packages/extension-task-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-list/)