ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update content

Browse Source
This commit is contained in:
Hans Pagel
2020-12-03 17:05:22 +01:00
parent e1fe9b4d50
commit 7c64c41084
14 changed files with 66 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/docPages/api/marks/bold.md
View File

@@ -22,9 +22,11 @@ yarn add @tiptap/extension-bold
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| ------- | ---------- | --------------- |
| bold | — | Mark text bold. |
| Command | Parameters | Description |
| ---------- | ---------- | ------------------ |
| setBold | — | Mark text as bold. |
| toggleBold | — | Toggle bold mark. |
| unsetBold | — | Remove bold mark. |
## Keyboard shortcuts
* Windows/Linux: `Control` `B`

8
docs/src/docPages/api/marks/code.md
View File

@@ -18,9 +18,11 @@ yarn add @tiptap/extension-code
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| ------- | ---------- | ------------------------- |
| code | — | Mark text as inline code. |
| Command | Parameters | Description |
| ---------- | ---------- | ------------------------- |
| setCode | — | Mark text as inline code. |
| toggleCode | — | Toggle inline code mark. |
| unsetCode | — | Remove inline code mark. |
## Keyboard shortcuts
* Windows/Linux: `Control` `E`

8
docs/src/docPages/api/marks/highlight.md
View File

@@ -18,9 +18,11 @@ yarn add @tiptap/extension-highlight
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Options | Description |
| --------- | ------- | ----------------------------------------------------------- |
| highlight | color | Mark text as highlighted, optionally pass a specific color. |
| 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`

9
docs/src/docPages/api/marks/italic.md
View File

@@ -22,9 +22,12 @@ yarn add @tiptap/extension-italic
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| ------- | ---------- | ----------------- |
| italic | — | Mark text italic. |
| Command | Parameters | Description |
| ------------ | ---------- | -------------------- |
| setItalic | — | Mark text as italic. |
| toggleItalic | — | Toggle italic mark. |
| unsetItalic | — | Remove italic mark. |
## Keyboard shortcuts
* Windows/Linux: `Control` `I`

8
docs/src/docPages/api/marks/link.md
View File

@@ -21,9 +21,11 @@ yarn add @tiptap/extension-link
| openOnClick | `Boolean` | `true` | If enabled, links will be opened on click. |
## Commands
| Command | Parameters | Description |
| ------- | -------------- | ----------------------------------------------------------- |
| link | href<br>target | Link the selected text. Removes a link, if `href` is empty. |
| Command | Parameters | Description |
| ---------- | ------------------ | -------------------------------------------- |
| setLink | `href`<br>`target` | Link the selected text. |
| toggleLink | `href`<br>`target` | Add or remove a link from the selected text. |
| unsetLink | – | Removes a link. |
## Keyboard shortcuts
:::warning Doesn’t have a keyboard shortcut

8
docs/src/docPages/api/marks/strike.md
View File

@@ -22,9 +22,11 @@ yarn add @tiptap/extension-strike
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| ------- | ---------- | --------------------------- |
| strike | — | Mark text as strikethrough. |
| Command | Parameters | Description |
| ------------ | ---------- | --------------------- |
| setStrike | — | Mark text as striked. |
| toggleStrike | — | Toggle strike mark. |
| unsetStrike | — | Remove strike mark. |
## Keyboard shortcuts
* Windows/Linux: `Control`&nbsp;`Shift`&nbsp;`X`

8
docs/src/docPages/api/marks/underline.md
View File

@@ -22,9 +22,11 @@ yarn add @tiptap/extension-underline
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| --------- | ---------- | ------------------------ |
| underline | — | Mark text as underlined. |
| Command | Parameters | Description |
| --------------- | ---------- | ------------------------ |
| setUnderline | — | Mark text as underlined. |
| toggleUnderline | — | Toggle underline mark. |
| unsetUnderline | — | Remove underline mark. |
## Keyboard shortcuts
* Windows/Linux: `Control`&nbsp;`U`