docs: make all mark commands a list

This commit is contained in:
Hans Pagel
2021-10-01 23:25:07 +02:00
parent d3aa7903bd
commit 86d8ecd238
9 changed files with 179 additions and 43 deletions

View File

@@ -25,11 +25,27 @@ yarn add @tiptap/extension-strike
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| ------------ | ---------- | --------------------- |
| setStrike | — | Mark text as striked. |
| toggleStrike | — | Toggle strike mark. |
| unsetStrike | — | Remove strike mark. |
### setStrike()
Mark text as striked.
```js
editor.commands.setStrike()
```
### toggleStrike()
Toggle strike mark.
```js
editor.commands.toggleStrike()
```
### unsetStrike()
Remove strike mark.
```js
editor.commands.unsetStrike()
```
## Keyboard shortcuts
| Command | Windows/Linux | macOS |