diff --git a/docs/src/demos/Extensions/HardBreak/index.spec.js b/docs/src/demos/Extensions/HardBreak/index.spec.js new file mode 100644 index 000000000..73c6f9088 --- /dev/null +++ b/docs/src/demos/Extensions/HardBreak/index.spec.js @@ -0,0 +1,5 @@ +context('/api/extensions/hard-break', () => { + beforeEach(() => { + cy.visit('/api/extensions/hard-break') + }) +}) \ No newline at end of file diff --git a/docs/src/demos/Extensions/HardBreak/index.vue b/docs/src/demos/Extensions/HardBreak/index.vue new file mode 100644 index 000000000..10588c467 --- /dev/null +++ b/docs/src/demos/Extensions/HardBreak/index.vue @@ -0,0 +1,55 @@ + + + \ No newline at end of file diff --git a/docs/src/docPages/api/extensions/blockquote.md b/docs/src/docPages/api/extensions/blockquote.md index fe1119071..75f54762e 100644 --- a/docs/src/docPages/api/extensions/blockquote.md +++ b/docs/src/docPages/api/extensions/blockquote.md @@ -11,7 +11,7 @@ The Blockquote extension enables you to use the `
` HTML tag in the e | ---------- | ------- | ----------------------------- | | blockquote | — | Wrap content in a blockquote. | -## Keybindings +## Keyboard shortcuts * `Control` + `→` ## Usage diff --git a/docs/src/docPages/api/extensions/bold.md b/docs/src/docPages/api/extensions/bold.md index e3a7682b9..f7daa1545 100644 --- a/docs/src/docPages/api/extensions/bold.md +++ b/docs/src/docPages/api/extensions/bold.md @@ -17,7 +17,7 @@ The extension will generate the corresponding `` HTML tags when reading | ------- | ------- | --------------- | | bold | — | Mark text bold. | -## Keybindings +## Keyboard shortcuts * Windows & Linux: `Control` + `B` * macOS: `Command` + `B` diff --git a/docs/src/docPages/api/extensions/bullet-list.md b/docs/src/docPages/api/extensions/bullet-list.md index dec853eb6..ce1409704 100644 --- a/docs/src/docPages/api/extensions/bullet-list.md +++ b/docs/src/docPages/api/extensions/bullet-list.md @@ -15,7 +15,7 @@ It’s intended to be used with the `ListItem` extension. | ----------- | ------- | --------------------- | | bullet_list | — | Toggle a bullet list. | -## Keybindings +## Keyboard shortcuts * `Control` + `Shift` + `8` ## Usage diff --git a/docs/src/docPages/api/extensions/code-block-highlight.md b/docs/src/docPages/api/extensions/code-block-highlight.md index 80cce0429..0d8e7d994 100644 --- a/docs/src/docPages/api/extensions/code-block-highlight.md +++ b/docs/src/docPages/api/extensions/code-block-highlight.md @@ -7,5 +7,5 @@ Enables you to use the `
` HTML tag with auto-detected syntax highlighting i
 ## Commands
 *None*
 
-## Keybindings
+## Keyboard shortcuts
 *None*
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/code-block.md b/docs/src/docPages/api/extensions/code-block.md
index 71e3b08d3..11e442891 100644
--- a/docs/src/docPages/api/extensions/code-block.md
+++ b/docs/src/docPages/api/extensions/code-block.md
@@ -7,5 +7,5 @@ Enables you to use the `
` HTML tag in the editor.
 ## Commands
 *None*
 
-## Keybindings
+## Keyboard shortcuts
 *None*
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions/code.md b/docs/src/docPages/api/extensions/code.md
index 034a337c6..147a9b139 100644
--- a/docs/src/docPages/api/extensions/code.md
+++ b/docs/src/docPages/api/extensions/code.md
@@ -11,7 +11,7 @@ The Code extensions enables you to use the `` HTML tag in the editor. If y
 | ------- | ------- | ------------------------- |
 | code    | —       | Mark text as inline code. |
 
-## Keybindings
+## Keyboard shortcuts
 * `Alt` + `
 
 ## Source Code
diff --git a/docs/src/docPages/api/extensions/hard-break.md b/docs/src/docPages/api/extensions/hard-break.md
index 9e1e84ac0..913cfdbb2 100644
--- a/docs/src/docPages/api/extensions/hard-break.md
+++ b/docs/src/docPages/api/extensions/hard-break.md
@@ -1,9 +1,18 @@
 # HardBreak
-Enables you to use the `
` HTML tag in the editor. +The HardBreak extensions adds support for the `
` HTML tag, which forces a line break. ## Options *None* -## Keybindings -* `Command` + `Enter` -* `Shift` + `Enter` \ No newline at end of file +## Commands +*None* + +## Keyboard shortcuts +* Windows & Linux: `Shift` + `Enter` +* macOS: `Command` + `Enter` + +## Source Code +[packages/extension-hard-break/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/) + +## Usage + diff --git a/docs/src/docPages/api/extensions/heading.md b/docs/src/docPages/api/extensions/heading.md index b39aca38b..7c4e19653 100644 --- a/docs/src/docPages/api/extensions/heading.md +++ b/docs/src/docPages/api/extensions/heading.md @@ -12,7 +12,7 @@ Enables you to use headline HTML tags in the editor. | ------- | ------- | ----------------------- | | heading | level | Creates a heading node. | -## Keybindings +## Keyboard shortcuts * `Control` + `Shift` + `1` → H1 * `Control` + `Shift` + `2` → H2 * `Control` + `Shift` + `3` → H3 diff --git a/docs/src/docPages/api/extensions/history.md b/docs/src/docPages/api/extensions/history.md index 363ec10fa..a4900072d 100644 --- a/docs/src/docPages/api/extensions/history.md +++ b/docs/src/docPages/api/extensions/history.md @@ -10,7 +10,7 @@ This extension provides history support. All changes to the document will be tra | undo | — | Undo the last change. | | redo | — | Redo the last change. | -## Keybindings +## Keyboard shortcuts * Windows & Linux: `Control` + `Z` * macOS: `Command` + `Z` diff --git a/docs/src/docPages/api/extensions/horizontal-rule.md b/docs/src/docPages/api/extensions/horizontal-rule.md index db333b614..5c64e87f9 100644 --- a/docs/src/docPages/api/extensions/horizontal-rule.md +++ b/docs/src/docPages/api/extensions/horizontal-rule.md @@ -11,7 +11,7 @@ Enables you to use the `
` HTML tag in the editor. | --------------- | ------- | ------------------------- | | horizontal_rule | — | Create a horizontal rule. | -## Keybindings +## Keyboard shortcuts *None* ## Usage diff --git a/docs/src/docPages/api/extensions/italic.md b/docs/src/docPages/api/extensions/italic.md index 625bf5439..892453ef1 100644 --- a/docs/src/docPages/api/extensions/italic.md +++ b/docs/src/docPages/api/extensions/italic.md @@ -15,7 +15,7 @@ The extension will generate the corresponding `` HTML tags when reading cont | ------- | ------- | ----------------- | | italic | — | Mark text italic. | -## Keybindings +## Keyboard shortcuts * Windows & Linux: `Control` + `I` * macOS: `Command` + `I` diff --git a/docs/src/docPages/api/extensions/ordered-list.md b/docs/src/docPages/api/extensions/ordered-list.md index af9584667..f53326fd7 100644 --- a/docs/src/docPages/api/extensions/ordered-list.md +++ b/docs/src/docPages/api/extensions/ordered-list.md @@ -15,7 +15,7 @@ This extensions is intended to be used with the `ListItem` extension. | ------------ | ------- | ----------------------- | | ordered_list | — | Toggle an ordered list. | -## Keybindings +## Keyboard shortcuts * `Control` + `Shift` + `9` ## Usage diff --git a/docs/src/docPages/api/extensions/paragraph.md b/docs/src/docPages/api/extensions/paragraph.md index afa82f971..b63265388 100644 --- a/docs/src/docPages/api/extensions/paragraph.md +++ b/docs/src/docPages/api/extensions/paragraph.md @@ -9,7 +9,7 @@ Yes, the schema is very strict. Without this extension you won’t even be able ## Commands *None* -## Keybindings +## Keyboard shortcuts *None* ## Source Code diff --git a/docs/src/docPages/api/extensions/strike.md b/docs/src/docPages/api/extensions/strike.md index 061c8ba84..d562d6ccd 100644 --- a/docs/src/docPages/api/extensions/strike.md +++ b/docs/src/docPages/api/extensions/strike.md @@ -11,7 +11,7 @@ Enables you to use the `` HTML tag in the editor. | ------- | ------- | --------------------------- | | strike | — | Mark text as strikethrough. | -## Keybindings +## Keyboard shortcuts * Windows & Linux: `Control` + `D` * macOS: `Command` + `D` diff --git a/docs/src/docPages/api/extensions/todo-item.md b/docs/src/docPages/api/extensions/todo-item.md index 729fed805..f1a8cef7c 100644 --- a/docs/src/docPages/api/extensions/todo-item.md +++ b/docs/src/docPages/api/extensions/todo-item.md @@ -13,5 +13,5 @@ This extensions is intended to be used with the `TodoList` extension. ## Commands *None* -## Keybindings +## Keyboard shortcuts *None* \ No newline at end of file diff --git a/docs/src/docPages/api/extensions/todo-list.md b/docs/src/docPages/api/extensions/todo-list.md index c4718f1ca..620a80110 100644 --- a/docs/src/docPages/api/extensions/todo-list.md +++ b/docs/src/docPages/api/extensions/todo-list.md @@ -13,7 +13,7 @@ This extensions is intended to be used with the `TodoItem` extension. | --------- | ------- | ----------------- | | todo_list | — | Toggle todo list. | -## Keybindings +## Keyboard shortcuts *None* ## Usage diff --git a/docs/src/docPages/api/extensions/underline.md b/docs/src/docPages/api/extensions/underline.md index 89e115d0a..3c4c57d5d 100644 --- a/docs/src/docPages/api/extensions/underline.md +++ b/docs/src/docPages/api/extensions/underline.md @@ -11,7 +11,7 @@ Enables you to use the `` HTML tag in the editor. | --------- | ------- | ------------------------ | | underline | — | Mark text as underlined. | -## Keybindings +## Keyboard shortcuts * Windows & Linux: `Control` + `U` * macOS: `Command` + `U`