tiptap/docs/src/docPages/api/nodes/blockquote.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Blockquote
2020-11-17 04:36:18 +08:00
The Blockquote extension enables you to use the `<blockquote>` HTML tag in the editor. This is great to use quotes in the editor.
2020-09-23 15:31:05 +08:00
Type <code>>&nbsp;</code> at the beginning of a new line and it will magically transform to a blockquote.
2020-09-21 22:59:28 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-09-21 22:59:28 +08:00
npm install @tiptap/extension-blockquote
2020-10-30 21:24:16 +08:00
# with Yarn
2020-09-21 22:59:28 +08:00
yarn add @tiptap/extension-blockquote
```
2020-08-19 03:39:41 +08:00
2020-09-23 18:03:03 +08:00
## Settings
2020-09-10 16:21:24 +08:00
| Option | Type | Default | Description |
| ------ | ------ | ------- | -------------------------------------------- |
| class | string | | Add a custom class to the rendered HTML tag. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
| Command | Parameters | Description |
| ---------- | ---------- | ----------------------------- |
| blockquote | — | Wrap content in a blockquote. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
* Windows/Linux: `Control`&nbsp;`Shift`&nbsp;`9`
* macOS: `Cmd`&nbsp;`Shift`&nbsp;`9`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
[packages/extension-blockquote/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/)
2020-08-19 03:39:41 +08:00
## Usage
<demo name="Nodes/Blockquote" highlight="3-5,17,36" />