docs: make all tables with only HTMLAttributes as a setting a lis

This commit is contained in:
Hans Pagel
2021-10-01 23:27:39 +02:00
parent 86d8ecd238
commit 2fccba79cb
14 changed files with 154 additions and 42 deletions

View File

@@ -20,9 +20,17 @@ yarn add @tiptap/extension-bold
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Blockquote.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -16,9 +16,17 @@ yarn add @tiptap/extension-code
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Code.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -20,9 +20,17 @@ yarn add @tiptap/extension-italic
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Italic.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -20,9 +20,17 @@ yarn add @tiptap/extension-strike
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Strike.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -14,9 +14,17 @@ yarn add @tiptap/extension-subscript
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Subscript.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -14,9 +14,17 @@ yarn add @tiptap/extension-superscript
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Superscript.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -20,9 +20,17 @@ yarn add @tiptap/extension-underline
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Underline.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands

View File

@@ -18,9 +18,17 @@ yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item
This extension requires the [`ListItem`](/api/nodes/list-item) node.
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
BulletList.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
| Command | Parameters | Description |

View File

@@ -16,9 +16,17 @@ yarn add @tiptap/extension-horizontal-rule
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
HorizontalRule.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
| Command | Parameters | Description |

View File

@@ -16,9 +16,17 @@ yarn add @tiptap/extension-list-item
This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
ListItem.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Keyboard shortcuts
| Command | Windows/Linux | macOS |

View File

@@ -18,9 +18,17 @@ yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item
This extension requires the [`ListItem`](/api/nodes/list-item) node.
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
OrderedList.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
| Command | Parameters | Description |

View File

@@ -18,9 +18,17 @@ yarn add @tiptap/extension-paragraph
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Paragraph.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
| Command | Parameters | Description |

View File

@@ -18,9 +18,17 @@ yarn add @tiptap/extension-task-list @tiptap/extension-task-item
This extension requires the [`TaskList`](/api/nodes/task-list) node.
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
TaskItem.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Keyboard shortcuts
| Command | Windows/Linux | macOS |

View File

@@ -18,9 +18,17 @@ yarn add @tiptap/extension-task-list @tiptap/extension-task-item
This extension requires the [`TaskItem`](/api/nodes/task-item) extension.
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
TaskList.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
| Command | Parameters | Description |