diff --git a/docs/src/demos/Extensions/Focus/index.spec.js b/docs/src/demos/Extensions/Focus/index.spec.js
new file mode 100644
index 00000000..029eb69e
--- /dev/null
+++ b/docs/src/demos/Extensions/Focus/index.spec.js
@@ -0,0 +1,9 @@
+context('/examples/focus', () => {
+ before(() => {
+ cy.visit('/examples/focus')
+ })
+
+ it('should have class', () => {
+ cy.get('.ProseMirror p:first').should('have.class', 'has-focus')
+ })
+})
diff --git a/docs/src/demos/Extensions/Focus/index.vue b/docs/src/demos/Extensions/Focus/index.vue
new file mode 100644
index 00000000..b4c7f0f3
--- /dev/null
+++ b/docs/src/demos/Extensions/Focus/index.vue
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+
+
diff --git a/docs/src/demos/Extensions/Bold/index.spec.js b/docs/src/demos/Marks/Bold/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Bold/index.spec.js
rename to docs/src/demos/Marks/Bold/index.spec.js
diff --git a/docs/src/demos/Extensions/Bold/index.vue b/docs/src/demos/Marks/Bold/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Bold/index.vue
rename to docs/src/demos/Marks/Bold/index.vue
diff --git a/docs/src/demos/Extensions/Code/index.spec.js b/docs/src/demos/Marks/Code/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Code/index.spec.js
rename to docs/src/demos/Marks/Code/index.spec.js
diff --git a/docs/src/demos/Extensions/Code/index.vue b/docs/src/demos/Marks/Code/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Code/index.vue
rename to docs/src/demos/Marks/Code/index.vue
diff --git a/docs/src/demos/Extensions/Italic/index.spec.js b/docs/src/demos/Marks/Italic/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Italic/index.spec.js
rename to docs/src/demos/Marks/Italic/index.spec.js
diff --git a/docs/src/demos/Extensions/Italic/index.vue b/docs/src/demos/Marks/Italic/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Italic/index.vue
rename to docs/src/demos/Marks/Italic/index.vue
diff --git a/docs/src/demos/Extensions/Link/index.spec.js b/docs/src/demos/Marks/Link/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Link/index.spec.js
rename to docs/src/demos/Marks/Link/index.spec.js
diff --git a/docs/src/demos/Extensions/Link/index.vue b/docs/src/demos/Marks/Link/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Link/index.vue
rename to docs/src/demos/Marks/Link/index.vue
diff --git a/docs/src/demos/Extensions/Strike/index.spec.js b/docs/src/demos/Marks/Strike/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Strike/index.spec.js
rename to docs/src/demos/Marks/Strike/index.spec.js
diff --git a/docs/src/demos/Extensions/Strike/index.vue b/docs/src/demos/Marks/Strike/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Strike/index.vue
rename to docs/src/demos/Marks/Strike/index.vue
diff --git a/docs/src/demos/Extensions/Underline/index.spec.js b/docs/src/demos/Marks/Underline/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Underline/index.spec.js
rename to docs/src/demos/Marks/Underline/index.spec.js
diff --git a/docs/src/demos/Extensions/Underline/index.vue b/docs/src/demos/Marks/Underline/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Underline/index.vue
rename to docs/src/demos/Marks/Underline/index.vue
diff --git a/docs/src/demos/Extensions/Blockquote/index.spec.js b/docs/src/demos/Nodes/Blockquote/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Blockquote/index.spec.js
rename to docs/src/demos/Nodes/Blockquote/index.spec.js
diff --git a/docs/src/demos/Extensions/Blockquote/index.vue b/docs/src/demos/Nodes/Blockquote/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Blockquote/index.vue
rename to docs/src/demos/Nodes/Blockquote/index.vue
diff --git a/docs/src/demos/Extensions/BulletList/index.spec.js b/docs/src/demos/Nodes/BulletList/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/BulletList/index.spec.js
rename to docs/src/demos/Nodes/BulletList/index.spec.js
diff --git a/docs/src/demos/Extensions/BulletList/index.vue b/docs/src/demos/Nodes/BulletList/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/BulletList/index.vue
rename to docs/src/demos/Nodes/BulletList/index.vue
diff --git a/docs/src/demos/Extensions/CodeBlock/index.spec.js b/docs/src/demos/Nodes/CodeBlock/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/CodeBlock/index.spec.js
rename to docs/src/demos/Nodes/CodeBlock/index.spec.js
diff --git a/docs/src/demos/Extensions/CodeBlock/index.vue b/docs/src/demos/Nodes/CodeBlock/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/CodeBlock/index.vue
rename to docs/src/demos/Nodes/CodeBlock/index.vue
diff --git a/docs/src/demos/Extensions/Document/index.spec.js b/docs/src/demos/Nodes/Document/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Document/index.spec.js
rename to docs/src/demos/Nodes/Document/index.spec.js
diff --git a/docs/src/demos/Extensions/Document/index.vue b/docs/src/demos/Nodes/Document/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Document/index.vue
rename to docs/src/demos/Nodes/Document/index.vue
diff --git a/docs/src/demos/Extensions/HardBreak/index.spec.js b/docs/src/demos/Nodes/HardBreak/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/HardBreak/index.spec.js
rename to docs/src/demos/Nodes/HardBreak/index.spec.js
diff --git a/docs/src/demos/Extensions/HardBreak/index.vue b/docs/src/demos/Nodes/HardBreak/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/HardBreak/index.vue
rename to docs/src/demos/Nodes/HardBreak/index.vue
diff --git a/docs/src/demos/Extensions/Heading/index.spec.js b/docs/src/demos/Nodes/Heading/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Heading/index.spec.js
rename to docs/src/demos/Nodes/Heading/index.spec.js
diff --git a/docs/src/demos/Extensions/Heading/index.vue b/docs/src/demos/Nodes/Heading/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Heading/index.vue
rename to docs/src/demos/Nodes/Heading/index.vue
diff --git a/docs/src/demos/Extensions/HorizontalRule/index.spec.js b/docs/src/demos/Nodes/HorizontalRule/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/HorizontalRule/index.spec.js
rename to docs/src/demos/Nodes/HorizontalRule/index.spec.js
diff --git a/docs/src/demos/Extensions/HorizontalRule/index.vue b/docs/src/demos/Nodes/HorizontalRule/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/HorizontalRule/index.vue
rename to docs/src/demos/Nodes/HorizontalRule/index.vue
diff --git a/docs/src/demos/Nodes/Image/index.spec.js b/docs/src/demos/Nodes/Image/index.spec.js
new file mode 100644
index 00000000..5740e17c
--- /dev/null
+++ b/docs/src/demos/Nodes/Image/index.spec.js
@@ -0,0 +1,27 @@
+context('/api/nodes/image', () => {
+ before(() => {
+ cy.visit('/api/nodes/image')
+ })
+
+ beforeEach(() => {
+ cy.get('.ProseMirror').then(([{ editor }]) => {
+ editor.setContent('
Example Text
')
+ editor.selectAll()
+ })
+ })
+
+ it('should add an img tag with the correct URL', () => {
+ cy.window().then(win => {
+ cy.stub(win, 'prompt').returns('foobar.png')
+
+ cy.get('.demo__preview button:first')
+ .click()
+
+ cy.window().its('prompt').should('be.called')
+
+ cy.get('.ProseMirror')
+ .find('img')
+ .should('have.attr', 'src', 'foobar.png')
+ })
+ })
+})
diff --git a/docs/src/demos/Extensions/Image/index.vue b/docs/src/demos/Nodes/Image/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Image/index.vue
rename to docs/src/demos/Nodes/Image/index.vue
diff --git a/docs/src/demos/Extensions/ListItem/index.spec.js b/docs/src/demos/Nodes/ListItem/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/ListItem/index.spec.js
rename to docs/src/demos/Nodes/ListItem/index.spec.js
diff --git a/docs/src/demos/Extensions/ListItem/index.vue b/docs/src/demos/Nodes/ListItem/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/ListItem/index.vue
rename to docs/src/demos/Nodes/ListItem/index.vue
diff --git a/docs/src/demos/Extensions/OrderedList/index.spec.js b/docs/src/demos/Nodes/OrderedList/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/OrderedList/index.spec.js
rename to docs/src/demos/Nodes/OrderedList/index.spec.js
diff --git a/docs/src/demos/Extensions/OrderedList/index.vue b/docs/src/demos/Nodes/OrderedList/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/OrderedList/index.vue
rename to docs/src/demos/Nodes/OrderedList/index.vue
diff --git a/docs/src/demos/Extensions/Paragraph/index.spec.js b/docs/src/demos/Nodes/Paragraph/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Paragraph/index.spec.js
rename to docs/src/demos/Nodes/Paragraph/index.spec.js
diff --git a/docs/src/demos/Extensions/Paragraph/index.vue b/docs/src/demos/Nodes/Paragraph/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Paragraph/index.vue
rename to docs/src/demos/Nodes/Paragraph/index.vue
diff --git a/docs/src/demos/Extensions/TaskList/index.vue b/docs/src/demos/Nodes/Text/TaskList/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/TaskList/index.vue
rename to docs/src/demos/Nodes/Text/TaskList/index.vue
diff --git a/docs/src/demos/Extensions/Text/index.spec.js b/docs/src/demos/Nodes/Text/index.spec.js
similarity index 100%
rename from docs/src/demos/Extensions/Text/index.spec.js
rename to docs/src/demos/Nodes/Text/index.spec.js
diff --git a/docs/src/demos/Extensions/Text/index.vue b/docs/src/demos/Nodes/Text/index.vue
similarity index 100%
rename from docs/src/demos/Extensions/Text/index.vue
rename to docs/src/demos/Nodes/Text/index.vue
diff --git a/docs/src/docPages/api/extensions/collaboration-cursor.md b/docs/src/docPages/api/extensions/collaboration-cursor.md
index 05fe4c05..8987916d 100644
--- a/docs/src/docPages/api/extensions/collaboration-cursor.md
+++ b/docs/src/docPages/api/extensions/collaboration-cursor.md
@@ -20,10 +20,9 @@ yarn add @tiptap/extension-collaboration-cursor
| type | | | |
## Commands
-*None*
-
-## Keyboard shortcuts
-*None*
+| Command | Parameters | Description |
+| ------- | ------------- | ------------------------------------------------------------------------ |
+| user | name
color | The name of the current user.
The color of the current user’s cursor. |
## 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/focus.md b/docs/src/docPages/api/extensions/focus.md
index c6f50867..6eacca5e 100644
--- a/docs/src/docPages/api/extensions/focus.md
+++ b/docs/src/docPages/api/extensions/focus.md
@@ -10,7 +10,10 @@ yarn add @tiptap/extension-focus
```
## Settings
-*None*
+| Option | Type | Default | Description |
+| --------- | ------- | --------- | ------------------------------------------------------ |
+| className | string | has-focus | The class that is applied to the focused element. |
+| nested | boolean | true | When enabled nested elements get the focus class, too. |
## Commands
*None*
@@ -22,4 +25,4 @@ yarn add @tiptap/extension-focus
[packages/extension-focus/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-focus/)
## Usage
-
+
diff --git a/docs/src/docPages/api/extensions/history.md b/docs/src/docPages/api/extensions/history.md
index c60438fd..b4fa23a6 100644
--- a/docs/src/docPages/api/extensions/history.md
+++ b/docs/src/docPages/api/extensions/history.md
@@ -17,7 +17,7 @@ yarn add @tiptap/extension-history
| newGroupDelay | number | 500 | The delay between changes after which a new group should be started (in milliseconds). When changes aren’t adjacent, a new group is always started. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | ------- | --------------------- |
| undo | — | Undo the last change. |
| redo | — | Redo the last change. |
diff --git a/docs/src/docPages/api/extensions/text-align.md b/docs/src/docPages/api/extensions/text-align.md
index dad00adf..3c6fcf8f 100644
--- a/docs/src/docPages/api/extensions/text-align.md
+++ b/docs/src/docPages/api/extensions/text-align.md
@@ -9,6 +9,15 @@ npm install @tiptap/extension-text-align
yarn add @tiptap/extension-text-align
```
+## Settings
+*None*
+
+## Commands
+*None*
+
+## Keyboard shortcuts
+*None*
+
## Source code
[packages/extension-text-align/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text-align/)
diff --git a/docs/src/docPages/api/marks/bold.md b/docs/src/docPages/api/marks/bold.md
index d9b14f65..d991247c 100644
--- a/docs/src/docPages/api/marks/bold.md
+++ b/docs/src/docPages/api/marks/bold.md
@@ -22,7 +22,7 @@ yarn add @tiptap/extension-bold
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | ------- | --------------- |
| bold | — | Mark text bold. |
@@ -34,4 +34,4 @@ yarn add @tiptap/extension-bold
[packages/extension-bold/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)
## Usage
-
+
diff --git a/docs/src/docPages/api/marks/code.md b/docs/src/docPages/api/marks/code.md
index ac5b1148..e6f34272 100644
--- a/docs/src/docPages/api/marks/code.md
+++ b/docs/src/docPages/api/marks/code.md
@@ -18,7 +18,7 @@ yarn add @tiptap/extension-code
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | ------- | ------------------------- |
| code | — | Mark text as inline code. |
@@ -29,4 +29,4 @@ yarn add @tiptap/extension-code
[packages/extension-code/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/)
## Usage
-
+
diff --git a/docs/src/docPages/api/marks/italic.md b/docs/src/docPages/api/marks/italic.md
index d9e55867..40717304 100644
--- a/docs/src/docPages/api/marks/italic.md
+++ b/docs/src/docPages/api/marks/italic.md
@@ -22,7 +22,7 @@ yarn add @tiptap/extension-italic
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | ------- | ----------------- |
| italic | — | Mark text italic. |
@@ -34,4 +34,4 @@ yarn add @tiptap/extension-italic
[packages/extension-italic/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/)
## Usage
-
+
diff --git a/docs/src/docPages/api/marks/link.md b/docs/src/docPages/api/marks/link.md
index 779a6377..30ce4b20 100644
--- a/docs/src/docPages/api/marks/link.md
+++ b/docs/src/docPages/api/marks/link.md
@@ -23,17 +23,17 @@ yarn add @tiptap/extension-link
| target | string | _blank | Set the default `target` of links. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | -------------- | ----------------------------------------------------------- |
| link | href
target | Link the selected text. Removes a link, if `href` is empty. |
## Keyboard shortcuts
:::warning Doesn’t have a keyboard shortcut
-This extension doesn’t bind a specific keyboard shortcut. You would probably open your UI on `Mod-k` though.
+This extension doesn’t bind a specific keyboard shortcut. You would probably open your custom UI on `Mod-k` though.
:::
## Source code
[packages/extension-link/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/)
## Usage
-
+
diff --git a/docs/src/docPages/api/marks/strike.md b/docs/src/docPages/api/marks/strike.md
index bb6660db..16a1b780 100644
--- a/docs/src/docPages/api/marks/strike.md
+++ b/docs/src/docPages/api/marks/strike.md
@@ -22,7 +22,7 @@ yarn add @tiptap/extension-strike
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
+| Command | Parameters | Description |
| ------- | ------- | --------------------------- |
| strike | — | Mark text as strikethrough. |
@@ -34,4 +34,4 @@ yarn add @tiptap/extension-strike
[packages/extension-strike/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/)
## Usage
-
+
diff --git a/docs/src/docPages/api/marks/underline.md b/docs/src/docPages/api/marks/underline.md
index fb478db3..2f5045a7 100644
--- a/docs/src/docPages/api/marks/underline.md
+++ b/docs/src/docPages/api/marks/underline.md
@@ -22,9 +22,9 @@ yarn add @tiptap/extension-underline
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| --------- | ------- | ------------------------ |
-| underline | — | Mark text as underlined. |
+| Command | Parameters | Description |
+| --------- | ---------- | ------------------------ |
+| underline | — | Mark text as underlined. |
## Keyboard shortcuts
* Windows/Linux: `Control` `U`
@@ -34,4 +34,4 @@ yarn add @tiptap/extension-underline
[packages/extension-underline/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/blockquote.md b/docs/src/docPages/api/nodes/blockquote.md
index dbd5038e..66de2089 100644
--- a/docs/src/docPages/api/nodes/blockquote.md
+++ b/docs/src/docPages/api/nodes/blockquote.md
@@ -19,9 +19,9 @@ yarn add @tiptap/extension-blockquote
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| ---------- | ------- | ----------------------------- |
-| blockquote | — | Wrap content in a blockquote. |
+| Command | Parameters | Description |
+| ---------- | ---------- | ----------------------------- |
+| blockquote | — | Wrap content in a blockquote. |
## Keyboard shortcuts
* Windows/Linux: `Control` `Shift` `9`
@@ -31,4 +31,4 @@ yarn add @tiptap/extension-blockquote
[packages/extension-blockquote/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/bullet-list.md b/docs/src/docPages/api/nodes/bullet-list.md
index 80902fb8..54ff543e 100644
--- a/docs/src/docPages/api/nodes/bullet-list.md
+++ b/docs/src/docPages/api/nodes/bullet-list.md
@@ -22,9 +22,9 @@ yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| ----------- | ------- | --------------------- |
-| bullet_list | — | Toggle a bullet list. |
+| Command | Parameters | Description |
+| ----------- | ---------- | --------------------- |
+| bullet_list | — | Toggle a bullet list. |
## Keyboard shortcuts
* `Control` `Shift` `8`
@@ -33,4 +33,4 @@ yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item
[packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/code-block.md b/docs/src/docPages/api/nodes/code-block.md
index 67d95523..1dce417e 100644
--- a/docs/src/docPages/api/nodes/code-block.md
+++ b/docs/src/docPages/api/nodes/code-block.md
@@ -23,9 +23,9 @@ yarn add @tiptap/extension-code-block
| languageClassPrefix | string | language- | Adds a prefix to language classes that are applied to code tags. |
## Commands
-| Command | Options | Description |
-| --------- | ------- | ----------------------------- |
-| codeBlock | — | Wrap content in a code block. |
+| Command | Parameters | Description |
+| --------- | ---------- | ----------------------------- |
+| codeBlock | — | Wrap content in a code block. |
## Keyboard shortcuts
* Windows/Linux: `Control` `Shift` `C`
@@ -35,4 +35,4 @@ yarn add @tiptap/extension-code-block
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/document.md b/docs/src/docPages/api/nodes/document.md
index 6e269e61..e887bed8 100644
--- a/docs/src/docPages/api/nodes/document.md
+++ b/docs/src/docPages/api/nodes/document.md
@@ -20,4 +20,4 @@ yarn add @tiptap/extension-document
[packages/extension-document/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/hard-break.md b/docs/src/docPages/api/nodes/hard-break.md
index 0f38111c..83fc2a99 100644
--- a/docs/src/docPages/api/nodes/hard-break.md
+++ b/docs/src/docPages/api/nodes/hard-break.md
@@ -10,13 +10,10 @@ npm install @tiptap/extension-hard-break
yarn add @tiptap/extension-hard-break
```
-## Settings
-*None*
-
## Commands
-| Command | Options | Description |
-| --------- | ------- | ----------------- |
-| hardBreak | — | Add a line break. |
+| Command | Parameters | Description |
+| --------- | ---------- | ----------------- |
+| hardBreak | — | Add a line break. |
## Keyboard shortcuts
* `Shift` `Enter`
@@ -27,4 +24,4 @@ yarn add @tiptap/extension-hard-break
[packages/extension-hard-break/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/heading.md b/docs/src/docPages/api/nodes/heading.md
index efca2149..652d0630 100644
--- a/docs/src/docPages/api/nodes/heading.md
+++ b/docs/src/docPages/api/nodes/heading.md
@@ -19,9 +19,9 @@ yarn add @tiptap/extension-heading
| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which heading levels are supported. |
## Commands
-| Command | Options | Description |
-| ------- | ------- | ----------------------- |
-| heading | level | Creates a heading node. |
+| Command | Parameters | Description |
+| ------- | ---------- | ------------------------------------------------ |
+| heading | level | Creates a heading node with the specified level. |
## Keyboard shortcuts
* Windows/Linux: `Control` `Alt` `1-6`
@@ -31,4 +31,4 @@ yarn add @tiptap/extension-heading
[packages/extension-heading/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/horizontal-rule.md b/docs/src/docPages/api/nodes/horizontal-rule.md
index 1de9d59d..81b6c0e7 100644
--- a/docs/src/docPages/api/nodes/horizontal-rule.md
+++ b/docs/src/docPages/api/nodes/horizontal-rule.md
@@ -18,9 +18,9 @@ yarn add @tiptap/extension-horizontal-rule
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| --------------- | ------- | ------------------------- |
-| horizontalRule | — | Create a horizontal rule. |
+| Command | Parameters | Description |
+| -------------- | ---------- | ------------------------- |
+| horizontalRule | — | Create a horizontal rule. |
## Keyboard shortcuts
*None*
@@ -29,4 +29,4 @@ yarn add @tiptap/extension-horizontal-rule
[packages/extension-horizontal-rule/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/image.md b/docs/src/docPages/api/nodes/image.md
index 1c3c9132..a4e93205 100644
--- a/docs/src/docPages/api/nodes/image.md
+++ b/docs/src/docPages/api/nodes/image.md
@@ -1,4 +1,9 @@
# Image
+Use this extension to render `
` HTML tags. By default, those images are blocks. If you want to render images in line with text set the `inline` option to `true`.
+
+:::warning Restrictions
+This extension does only the rendering of images. It doesn’t upload images to your server, that’s a whole different story.
+:::
## Installation
```bash
@@ -10,12 +15,12 @@ yarn add @tiptap/extension-image
```
## Settings
-| Option | Type | Default | Description |
-| ------ | ------- | ------- | ------------------------ |
-| inline | boolean | false | Renders the node inline. |
+| Option | Type | Default | Description |
+| ------ | ------- | ------- | ------------------------------ |
+| inline | boolean | false | Renders the image node inline. |
## Source code
[packages/extension-image/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-image/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/list-item.md b/docs/src/docPages/api/nodes/list-item.md
index 8d6e816e..16926eed 100644
--- a/docs/src/docPages/api/nodes/list-item.md
+++ b/docs/src/docPages/api/nodes/list-item.md
@@ -31,4 +31,4 @@ yarn add @tiptap/extension-list-item
[packages/extension-list-item/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/ordered-list.md b/docs/src/docPages/api/nodes/ordered-list.md
index 062cdb7f..b5980e3d 100644
--- a/docs/src/docPages/api/nodes/ordered-list.md
+++ b/docs/src/docPages/api/nodes/ordered-list.md
@@ -22,9 +22,9 @@ yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| ------------ | ------- | ---------------------- |
-| ordered_list | — | Toggle a ordered list. |
+| Command | Parameters | Description |
+| ----------- | ---------- | ---------------------- |
+| orderedList | — | Toggle a ordered list. |
## Keyboard shortcuts
* `Control` `Shift` `9`
@@ -33,4 +33,4 @@ yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item
[packages/extension-ordered-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/paragraph.md b/docs/src/docPages/api/nodes/paragraph.md
index 7cae8a4c..6a3013d7 100644
--- a/docs/src/docPages/api/nodes/paragraph.md
+++ b/docs/src/docPages/api/nodes/paragraph.md
@@ -20,9 +20,9 @@ yarn add @tiptap/extension-paragraph
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| --------- | ------- | -------------------------------------------- |
-| paragraph | — | Transforms all selected nodes to paragraphs. |
+| Command | Parameters | Description |
+| --------- | ---------- | -------------------------------------------- |
+| paragraph | — | Transforms all selected nodes to paragraphs. |
## Keyboard shortcuts
* Windows & Linux: `Control` `Alt` `0`
@@ -32,4 +32,4 @@ yarn add @tiptap/extension-paragraph
[packages/extension-paragraph/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/task-item.md b/docs/src/docPages/api/nodes/task-item.md
index a7228168..5a5738f6 100644
--- a/docs/src/docPages/api/nodes/task-item.md
+++ b/docs/src/docPages/api/nodes/task-item.md
@@ -25,4 +25,4 @@ yarn add @tiptap/extension-task-list @tiptap/extension-task-item
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-item/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/task-list.md b/docs/src/docPages/api/nodes/task-list.md
index 44b8d962..ae1bfa9e 100644
--- a/docs/src/docPages/api/nodes/task-list.md
+++ b/docs/src/docPages/api/nodes/task-list.md
@@ -20,12 +20,12 @@ yarn add @tiptap/extension-task-list @tiptap/extension-task-item
| class | string | – | Add a custom class to the rendered HTML tag. |
## Commands
-| Command | Options | Description |
-| -------- | ------- | ------------------- |
-| taskList | — | Toggle a task list. |
+| Command | Parameters | Description |
+| -------- | ---------- | ------------------- |
+| taskList | — | Toggle a task list. |
## Source code
[packages/extension-task-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-list/)
## Usage
-
+
diff --git a/docs/src/docPages/api/nodes/text.md b/docs/src/docPages/api/nodes/text.md
index 5502739b..c283cc72 100644
--- a/docs/src/docPages/api/nodes/text.md
+++ b/docs/src/docPages/api/nodes/text.md
@@ -18,4 +18,4 @@ yarn add @tiptap/extension-text
[packages/extension-text/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/)
## Usage
-
+
diff --git a/docs/src/links.yaml b/docs/src/links.yaml
index f6a0886b..29e51fd8 100644
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@@ -127,7 +127,6 @@
link: /api/nodes/horizontal-rule
- title: Image
link: /api/nodes/image
- draft: true
- title: ListItem
link: /api/nodes/list-item
- title: OrderedList