docs(docs): 📝 add missing documentation for commands

This commit is contained in:
Dominik Biedebach
2022-06-08 12:41:14 +02:00
parent 43f8843c3e
commit 4abd7c8827
12 changed files with 151 additions and 44 deletions

View File

@@ -1,5 +1,16 @@
# splitBlock
`splitBlock` will split the current node into two nodes at the current [NodeSelection](https://prosemirror.net/docs/ref/#state.NodeSelection). If the current selection is not splittable, the command will be ignored.
:::warning
Oops, we didnt find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, its still a side project for us. Lets change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis)
:::
## Parameters
`options: Record<string, any>`
* `keepMarks: boolean` - Defines if the marks should be kept or removed. Defaults to `true`.
## Usage
```js
// split the current node and keep marks
editor.commands.splitBlock()
// split the current node and don't keep marks
editor.commands.splitBlock({ keepMarks: false })
```