improve extensions documentation

This commit is contained in:
Hans Pagel
2020-08-20 15:44:08 +02:00
parent cbe8e1f357
commit ec2a6e86b3
20 changed files with 41 additions and 27 deletions

View File

@@ -0,0 +1,57 @@
# HorizontalRule
Enables you to use the `<hr>` HTML tag in the editor.
## Options
*None*
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| horizontal_rule | none | Create a horizontal rule. |
## Keybindings
*None*
## Usage
```markup
<template>
<div>
<editor-menu-bar :editor="editor" v-slot="{ commands, isActive }">
<button type="button" @click="commands.horizontal_rule">
Horizontal Rule
</button>
</editor-menu-bar>
<editor-content :editor="editor" />
</div>
</template>
<script>
import { Editor, EditorContent, EditorMenuBar } from 'tiptap'
import { HorizontalRule } from 'tiptap-extensions'
export default {
components: {
EditorMenuBar,
EditorContent,
},
data() {
return {
editor: new Editor({
extensions: [
new HorizontalRule(),
],
content: `
<p>Some text.</p>
<hr />
<p>Text again.</p>
`,
}),
}
},
beforeDestroy() {
this.editor.destroy()
}
}
</script>
```