1.2 KiB
1.2 KiB
Highlight
Use this extension to render highlighted text with <mark>. You can use only default <mark> HTML tag, which has a yellow background color by default, or apply different colors.
Type ==two equal signs== and it will magically transform to highlighted text while you type.
Installation
# With npm
npm install @tiptap/extension-highlight
# Or: With Yarn
yarn add @tiptap/extension-highlight
Settings
| Option | Type | Default | Description |
|---|---|---|---|
| class | string | – | Add a custom class to the rendered HTML tag. |
Commands
| Command | Options | Description |
|---|---|---|
| highlight | color | Mark text as highlighted, optionally pass a specific color. |
Keyboard shortcuts
- Windows/Linux:
ControlE - macOS:
CmdE