remove gridsome
This commit is contained in:
39
docs/api/marks/highlight.md
Normal file
39
docs/api/marks/highlight.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Highlight
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-highlight)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-highlight?minimal=true)
|
||||
|
||||
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 <mark>highlighted</mark> text while you type.
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
# with npm
|
||||
npm install @tiptap/extension-highlight
|
||||
|
||||
# with Yarn
|
||||
yarn add @tiptap/extension-highlight
|
||||
```
|
||||
|
||||
## Settings
|
||||
| Option | Type | Default | Description |
|
||||
| -------------- | --------- | ------- | --------------------------------------------------------------------- |
|
||||
| multicolor | `Boolean` | `false` | Add support for multiple colors. |
|
||||
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
||||
|
||||
## Commands
|
||||
| Command | Options | Description |
|
||||
| --------------- | ------------------ | ------------------------- |
|
||||
| setHighlight | `color` (optional) | Mark text as highlighted. |
|
||||
| toggleHighlight | `color` (optional) | Toggle a text highlight. |
|
||||
| unsetHighlight | — | Removes the highlight. |
|
||||
|
||||
## Keyboard shortcuts
|
||||
* Windows/Linux: `Control` `Shift` `H`
|
||||
* macOS: `Cmd` `Shift` `H`
|
||||
|
||||
## Source code
|
||||
[packages/extension-highlight/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-highlight/)
|
||||
|
||||
## Usage
|
||||
<tiptap-demo name="Marks/Highlight"></tiptap-demo>
|
||||
Reference in New Issue
Block a user