diff --git a/docs/src/docPages/api/extensions.md b/docs/src/docPages/api/extensions.md index 98bd8a8b..28426d24 100644 --- a/docs/src/docPages/api/extensions.md +++ b/docs/src/docPages/api/extensions.md @@ -12,24 +12,24 @@ You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which in ## List of supported extensions -| Title | Default Extension | Source Code | -| ----- | ------- | ----------- | -| [Blockquote](/api/extensions/blockquote) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/) -| [Bold](/api/extensions/bold) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/) -| [BulletList](/api/extensions/bullet-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/) -| [Code](/api/extensions/code) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/) -| [Document](/api/extensions/document) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/) -| [HardBreak](/api/extensions/hard-break) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/) -| [Heading](/api/extensions/heading) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/) -| [History](/api/extensions/history) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/) -| [HorizontalRule](/api/extensions/horizontal-rule) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/) -| [Italic](/api/extensions/italic) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/) -| [Link](/api/extensions/link) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/) -| [OrderedList](/api/extensions/ordered-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/) -| [Paragraph](/api/extensions/paragraph) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/) -| [Strike](/api/extensions/strike) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/) -| [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/) -| [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) +| Title | Default Extension | Source Code | +| ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- | +| [Blockquote](/api/extensions/blockquote) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/) | +| [Bold](/api/extensions/bold) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/) | +| [BulletList](/api/extensions/bullet-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/) | +| [Code](/api/extensions/code) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/) | +| [Document](/api/extensions/document) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/) | +| [HardBreak](/api/extensions/hard-break) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/) | +| [Heading](/api/extensions/heading) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/) | +| [History](/api/extensions/history) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/) | +| [HorizontalRule](/api/extensions/horizontal-rule) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/) | +| [Italic](/api/extensions/italic) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/) | +| [Link](/api/extensions/link) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/) | +| [OrderedList](/api/extensions/ordered-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/) | +| [Paragraph](/api/extensions/paragraph) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/) | +| [Strike](/api/extensions/strike) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/) | +| [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/) | +| [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) | diff --git a/docs/src/docPages/api/extensions/blockquote.md b/docs/src/docPages/api/extensions/blockquote.md index 180c5b68..fe111907 100644 --- a/docs/src/docPages/api/extensions/blockquote.md +++ b/docs/src/docPages/api/extensions/blockquote.md @@ -2,14 +2,14 @@ The Blockquote extension enables you to use the `
` HTML tag in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| blockquote | — | Wrap content in a blockquote. | +| Command | Options | Description | +| ---------- | ------- | ----------------------------- | +| blockquote | — | Wrap content in a blockquote. | ## Keybindings * `Control` + `→` diff --git a/docs/src/docPages/api/extensions/bold.md b/docs/src/docPages/api/extensions/bold.md index f45b469b..4259666d 100644 --- a/docs/src/docPages/api/extensions/bold.md +++ b/docs/src/docPages/api/extensions/bold.md @@ -6,14 +6,14 @@ The extension will generate the corresponding `` HTML tags when reading ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------- | ------- | ----------- | -| bold | — | Mark text bold. | +| Command | Options | Description | +| ------- | ------- | --------------- | +| bold | — | Mark text bold. | ## Keybindings * Windows & Linux: `Control` + `B` diff --git a/docs/src/docPages/api/extensions/bullet-list.md b/docs/src/docPages/api/extensions/bullet-list.md index b85fe1c3..dec853eb 100644 --- a/docs/src/docPages/api/extensions/bullet-list.md +++ b/docs/src/docPages/api/extensions/bullet-list.md @@ -6,14 +6,14 @@ It’s intended to be used with the `ListItem` extension. ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| bullet_list | — | Toggle a bullet list. | +| Command | Options | Description | +| ----------- | ------- | --------------------- | +| bullet_list | — | Toggle a bullet list. | ## Keybindings * `Control` + `Shift` + `8` diff --git a/docs/src/docPages/api/extensions/code.md b/docs/src/docPages/api/extensions/code.md index 5e1056c0..034a337c 100644 --- a/docs/src/docPages/api/extensions/code.md +++ b/docs/src/docPages/api/extensions/code.md @@ -2,14 +2,14 @@ The Code extensions enables you to use the `` HTML tag in the editor. If you paste in text with `` tags it will rendered accordingly. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------- | ------- | ----------- | -| code | — | Mark text as inline code. | +| Command | Options | Description | +| ------- | ------- | ------------------------- | +| code | — | Mark text as inline code. | ## Keybindings * `Alt` + ` diff --git a/docs/src/docPages/api/extensions/heading.md b/docs/src/docPages/api/extensions/heading.md index 3b58c236..b39aca38 100644 --- a/docs/src/docPages/api/extensions/heading.md +++ b/docs/src/docPages/api/extensions/heading.md @@ -2,15 +2,15 @@ Enables you to use headline HTML tags in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | -| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. | +| Option | Type | Default | Description | +| ------ | ------ | ------------------ | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | +| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| heading | level | Creates a heading node. | +| Command | Options | Description | +| ------- | ------- | ----------------------- | +| heading | level | Creates a heading node. | ## Keybindings * `Control` + `Shift` + `1` → H1 diff --git a/docs/src/docPages/api/extensions/history.md b/docs/src/docPages/api/extensions/history.md index 3ca51a22..363ec10f 100644 --- a/docs/src/docPages/api/extensions/history.md +++ b/docs/src/docPages/api/extensions/history.md @@ -5,10 +5,10 @@ This extension provides history support. All changes to the document will be tra *None* ## Commands -| Command | Options | Description | -| ------- | ------- | ----------- | -| undo | — | Undo the last change. | -| redo | — | Redo the last change. | +| Command | Options | Description | +| ------- | ------- | --------------------- | +| undo | — | Undo the last change. | +| redo | — | Redo the last change. | ## Keybindings * Windows & Linux: `Control` + `Z` diff --git a/docs/src/docPages/api/extensions/horizontal-rule.md b/docs/src/docPages/api/extensions/horizontal-rule.md index a1f6ee30..db333b61 100644 --- a/docs/src/docPages/api/extensions/horizontal-rule.md +++ b/docs/src/docPages/api/extensions/horizontal-rule.md @@ -2,14 +2,14 @@ Enables you to use the `
` HTML tag in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| horizontal_rule | — | Create a horizontal rule. | +| Command | Options | Description | +| --------------- | ------- | ------------------------- | +| horizontal_rule | — | Create a horizontal rule. | ## Keybindings *None* diff --git a/docs/src/docPages/api/extensions/italic.md b/docs/src/docPages/api/extensions/italic.md index c9387a39..625bf543 100644 --- a/docs/src/docPages/api/extensions/italic.md +++ b/docs/src/docPages/api/extensions/italic.md @@ -6,14 +6,14 @@ The extension will generate the corresponding `` HTML tags when reading cont ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------- | ------- | ----------- | -| italic | — | Mark text italic. | +| Command | Options | Description | +| ------- | ------- | ----------------- | +| italic | — | Mark text italic. | ## Keybindings * Windows & Linux: `Control` + `I` diff --git a/docs/src/docPages/api/extensions/link.md b/docs/src/docPages/api/extensions/link.md index 8d1e9c4a..b796eb3a 100644 --- a/docs/src/docPages/api/extensions/link.md +++ b/docs/src/docPages/api/extensions/link.md @@ -2,7 +2,7 @@ Enables you to use the `` HTML tag in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | -| openOnClick | Boolean | true | Specifies if links will be opened on click. | +| Option | Type | Default | Description | +| ----------- | ------- | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | +| openOnClick | Boolean | true | Specifies if links will be opened on click. | diff --git a/docs/src/docPages/api/extensions/list-item.md b/docs/src/docPages/api/extensions/list-item.md index 7e25bca6..4a072695 100644 --- a/docs/src/docPages/api/extensions/list-item.md +++ b/docs/src/docPages/api/extensions/list-item.md @@ -6,6 +6,6 @@ This extensions is intended to be used with the `BulletList` or `OrderedList` ex ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | \ No newline at end of file +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | \ No newline at end of file diff --git a/docs/src/docPages/api/extensions/ordered-list.md b/docs/src/docPages/api/extensions/ordered-list.md index 19a31083..af958466 100644 --- a/docs/src/docPages/api/extensions/ordered-list.md +++ b/docs/src/docPages/api/extensions/ordered-list.md @@ -6,14 +6,14 @@ This extensions is intended to be used with the `ListItem` extension. ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| ordered_list | — | Toggle an ordered list. | +| Command | Options | Description | +| ------------ | ------- | ----------------------- | +| ordered_list | — | Toggle an ordered list. | ## Keybindings * `Control` + `Shift` + `9` diff --git a/docs/src/docPages/api/extensions/paragraph.md b/docs/src/docPages/api/extensions/paragraph.md index d35713a8..afa82f97 100644 --- a/docs/src/docPages/api/extensions/paragraph.md +++ b/docs/src/docPages/api/extensions/paragraph.md @@ -2,9 +2,9 @@ Yes, the schema is very strict. Without this extension you won’t even be able to use paragraphs in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands *None* diff --git a/docs/src/docPages/api/extensions/strike.md b/docs/src/docPages/api/extensions/strike.md index d6548c86..061c8ba8 100644 --- a/docs/src/docPages/api/extensions/strike.md +++ b/docs/src/docPages/api/extensions/strike.md @@ -2,14 +2,14 @@ Enables you to use the `` HTML tag in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| strike | — | Mark text as strikethrough. | +| Command | Options | Description | +| ------- | ------- | --------------------------- | +| strike | — | Mark text as strikethrough. | ## Keybindings * Windows & Linux: `Control` + `D` diff --git a/docs/src/docPages/api/extensions/todo-item.md b/docs/src/docPages/api/extensions/todo-item.md index aa6756ef..729fed80 100644 --- a/docs/src/docPages/api/extensions/todo-item.md +++ b/docs/src/docPages/api/extensions/todo-item.md @@ -6,9 +6,9 @@ This extensions is intended to be used with the `TodoList` extension. ::: ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| nested | Boolean | false | Specifies if you can nest todo lists. | +| Option | Type | Default | Description | +| ------ | ------- | ------- | ------------------------------------- | +| nested | Boolean | false | Specifies if you can nest todo lists. | ## Commands *None* diff --git a/docs/src/docPages/api/extensions/todo-list.md b/docs/src/docPages/api/extensions/todo-list.md index 2fefea44..c4718f1c 100644 --- a/docs/src/docPages/api/extensions/todo-list.md +++ b/docs/src/docPages/api/extensions/todo-list.md @@ -9,9 +9,9 @@ This extensions is intended to be used with the `TodoItem` extension. *None* ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| todo_list | — | Toggle todo list. | +| Command | Options | Description | +| --------- | ------- | ----------------- | +| todo_list | — | Toggle todo list. | ## Keybindings *None* diff --git a/docs/src/docPages/api/extensions/underline.md b/docs/src/docPages/api/extensions/underline.md index 00d4272c..89e115d0 100644 --- a/docs/src/docPages/api/extensions/underline.md +++ b/docs/src/docPages/api/extensions/underline.md @@ -2,14 +2,14 @@ Enables you to use the `` HTML tag in the editor. ## Options -| Option | Type | Default | Description | -| ------ | ---- | ------- | ----------- | -| class | string | – | Add a custom class to the rendered HTML tag. | +| Option | Type | Default | Description | +| ------ | ------ | ------- | -------------------------------------------- | +| class | string | – | Add a custom class to the rendered HTML tag. | ## Commands -| Command | Options | Description | -| ------ | ---- | ---------------- | -| underline | — | Mark text as underlined. | +| Command | Options | Description | +| --------- | ------- | ------------------------ | +| underline | — | Mark text as underlined. | ## Keybindings * Windows & Linux: `Control` + `U`