remove gridsome

2021-09-16 14:41:25 +02:00
parent e012a29240
commit 2f15a11572
311 changed files with 157 additions and 10308 deletions
--- a/docs/api/marks/bold.md
+++ b/docs/api/marks/bold.md
@@ -0,0 +1,42 @@
+# Bold
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-bold.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-bold)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-bold.svg)](https://npmcharts.com/compare/@tiptap/extension-bold?minimal=true)
+
+Use this extension to render text in **bold**. If you pass `<strong>`, `<b>` tags, or text with inline `style` attributes setting the `font-weight` CSS rule in the editor’s initial content, they all will be rendered accordingly.
+
+Type `**two asterisks**` or `__two underlines__` and it will magically transform to **bold** text while you type.
+
+::: warning Restrictions
+The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked bold, regardless of the method will be normalized to `<strong>` HTML tags.
+:::
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-bold
+
+# with Yarn
+yarn add @tiptap/extension-bold
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command    | Parameters | Description        |
+| ---------- | ---------- | ------------------ |
+| setBold    | —          | Mark text as bold. |
+| toggleBold | —          | Toggle bold mark.  |
+| unsetBold  | —          | Remove bold mark.  |
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`B`
+* macOS: `Cmd`&nbsp;`B`
+
+## Source code
+[packages/extension-bold/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bold/)
+
+## Usage
+<tiptap-demo name="Marks/Bold"></tiptap-demo>
--- a/docs/api/marks/code.md
+++ b/docs/api/marks/code.md
@@ -0,0 +1,38 @@
+# Code
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-code.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-code)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-code.svg)](https://npmcharts.com/compare/@tiptap/extension-code?minimal=true)
+
+The Code extensions enables you to use the `<code>` HTML tag in the editor. If you paste in text with `<code>` tags it will rendered accordingly.
+
+Type something with <code>\`back-ticks around\`</code> and it will magically transform to `inline code` while you type.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-code
+
+# with Yarn
+yarn add @tiptap/extension-code
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command    | Parameters | Description               |
+| ---------- | ---------- | ------------------------- |
+| setCode    | —          | Mark text as inline code. |
+| toggleCode | —          | Toggle inline code mark.  |
+| unsetCode  | —          | Remove inline code mark.  |
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`E`
+* macOS: `Cmd`&nbsp;`E`
+
+## Source code
+[packages/extension-code/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)
+
+## Usage
+<tiptap-demo name="Marks/Code"></tiptap-demo>
--- a/docs/api/marks/highlight.md
+++ b/docs/api/marks/highlight.md
@@ -0,0 +1,39 @@
+# Highlight
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-highlight.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-highlight)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-highlight.svg)](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`&nbsp;`Shift`&nbsp;`H`
+* macOS: `Cmd`&nbsp;`Shift`&nbsp;`H`
+
+## Source code
+[packages/extension-highlight/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-highlight/)
+
+## Usage
+<tiptap-demo name="Marks/Highlight"></tiptap-demo>
--- a/docs/api/marks/italic.md
+++ b/docs/api/marks/italic.md
@@ -0,0 +1,43 @@
+# Italic
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-italic.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-italic)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-italic.svg)](https://npmcharts.com/compare/@tiptap/extension-italic?minimal=true)
+
+Use this extension to render text in *italic*. If you pass `<em>`, `<i>` tags, or text with inline `style` attributes setting `font-style: italic` in the editor’s initial content, they all will be rendered accordingly.
+
+Type `*one asterisk*` or `_one underline_` and it will magically transform to *italic* text while you type.
+
+::: warning Restrictions
+The extension will generate the corresponding `<em>` HTML tags when reading contents of the `Editor` instance. All text marked italic, regardless of the method will be normalized to `<em>` HTML tags.
+:::
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-italic
+
+# with Yarn
+yarn add @tiptap/extension-italic
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command      | Parameters | Description          |
+| ------------ | ---------- | -------------------- |
+| setItalic    | —          | Mark text as italic. |
+| toggleItalic | —          | Toggle italic mark.  |
+| unsetItalic  | —          | Remove italic mark.  |
+
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`I`
+* macOS: `Cmd`&nbsp;`I`
+
+## Source code
+[packages/extension-italic/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)
+
+## Usage
+<tiptap-demo name="Marks/Italic"></tiptap-demo>
--- a/docs/api/marks/link.md
+++ b/docs/api/marks/link.md
@@ -0,0 +1,43 @@
+# Link
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-link.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-link)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-link.svg)](https://npmcharts.com/compare/@tiptap/extension-link?minimal=true)
+
+The Link extension adds support for `<a>` tags to the editor. The extension is headless too, there is no actual UI to add, modify or delete links. The usage example below uses the native JavaScript prompt to show you how that could work.
+
+In a real world application, you would probably add a more sophisticated user interface.
+
+Pasted URLs will be transformed to links automatically.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-link
+
+# with Yarn
+yarn add @tiptap/extension-link
+```
+
+## Settings
+| Option         | Type      | Default                                                     | Description                                                                      |
+| -------------- | --------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| HTMLAttributes | `Object`  | `{ target: '_blank', rel: 'noopener noreferrer nofollow' }` | Custom HTML attributes that should be added to the rendered HTML tag.            |
+| openOnClick    | `Boolean` | `true`                                                      | If enabled, links will be opened on click.                                       |
+| linkOnPaste    | `Boolean` | `true`                                                      | Adds a link to the current selection if the pasted content only contains an url. |
+
+## Commands
+| 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
+This extension doesn’t bind a specific keyboard shortcut. You would probably open your custom UI on `Mod-k` though.
+:::
+
+## Source code
+[packages/extension-link/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-link/)
+
+## Usage
+<tiptap-demo name="Marks/Link"></tiptap-demo>
--- a/docs/api/marks/strike.md
+++ b/docs/api/marks/strike.md
@@ -0,0 +1,42 @@
+# Strike
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-strike.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-strike)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-strike.svg)](https://npmcharts.com/compare/@tiptap/extension-strike?minimal=true)
+
+Use this extension to render ~~striked text~~. If you pass `<s>`, `<del>`, `<strike>` tags, or text with inline `style` attributes setting `text-decoration: line-through` in the editor’s initial content, they all will be rendered accordingly.
+
+Type <code>&Tilde;&Tilde;text between tildes&Tilde;&Tilde;</code> and it will be magically ~~striked through~~ while you type.
+
+::: warning Restrictions
+The extension will generate the corresponding `<s>` HTML tags when reading contents of the `Editor` instance. All text striked through, regardless of the method will be normalized to `<s>` HTML tags.
+:::
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-strike
+
+# with Yarn
+yarn add @tiptap/extension-strike
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| 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`
+* macOS: `Cmd`&nbsp;`Shift`&nbsp;`X`
+
+## Source code
+[packages/extension-strike/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)
+
+## Usage
+<tiptap-demo name="Marks/Strike"></tiptap-demo>
--- a/docs/api/marks/subscript.md
+++ b/docs/api/marks/subscript.md
@@ -0,0 +1,36 @@
+# Subscript
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-subscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-subscript)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-subscript.svg)](https://npmcharts.com/compare/@tiptap/extension-subscript?minimal=true)
+
+Use this extension to render text in <sub>subscript</sub>. If you pass `<sub>` or text with `vertical-align: sub` as inline style in the editor’s initial content, both will be normalized to a `<sub>` HTML tag.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-subscript
+
+# with Yarn
+yarn add @tiptap/extension-subscript
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command         | Parameters | Description               |
+| --------------- | ---------- | ------------------------- |
+| setSubscript    | —          | Mark text as subscript. |
+| toggleSubscript | —          | Toggle subscript mark.  |
+| unsetSubscript  | —          | Remove subscript mark.  |
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`,`
+* macOS: `Cmd`&nbsp;`,`
+
+## Source code
+[packages/extension-subscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)
+
+## Usage
+<tiptap-demo name="Marks/Subscript"></tiptap-demo>
--- a/docs/api/marks/superscript.md
+++ b/docs/api/marks/superscript.md
@@ -0,0 +1,36 @@
+# Superscript
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-superscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-superscript)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-superscript.svg)](https://npmcharts.com/compare/@tiptap/extension-superscript?minimal=true)
+
+Use this extension to render text in <sup>superscript</sup>. If you pass `<sup>` or text with `vertical-align: super` as inline style in the editor’s initial content, both will be normalized to a `<sup>` HTML tag.
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-superscript
+
+# with Yarn
+yarn add @tiptap/extension-superscript
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command           | Parameters | Description               |
+| ----------------- | ---------- | ------------------------- |
+| setSuperscript    | —          | Mark text as superscript. |
+| toggleSuperscript | —          | Toggle superscript mark.  |
+| unsetSuperscript  | —          | Remove superscript mark.  |
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`.`
+* macOS: `Cmd`&nbsp;`.`
+
+## Source code
+[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
+
+## Usage
+<tiptap-demo name="Marks/Superscript"></tiptap-demo>
--- a/docs/api/marks/text-style.md
+++ b/docs/api/marks/text-style.md
@@ -0,0 +1,25 @@
+# TextStyle
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-text-style.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-text-style)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-text-style.svg)](https://npmcharts.com/compare/@tiptap/extension-text-style?minimal=true)
+
+This mark renders a `<span>` HTML tag and enables you to add a list of styling related attributes, for example font-family, font-size, or color. The extension doesn’t add any styling attribute by default, but other extensions use it as the foundation, for example [`FontFamily`](/api/extensions/font-family) or [`Color`](/api/extensions/color).
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-text-style
+
+# with Yarn
+yarn add @tiptap/extension-text-style
+```
+
+## Commands
+| Command              | Parameters | Description                                   |
+| -------------------- | ---------- | --------------------------------------------- |
+| removeEmptyTextStyle | –          | Remove `<span>` tags without an inline style. |
+
+## Source code
+[packages/extension-text-style/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-style/)
+
+## Usage
+<tiptap-demo name="Marks/TextStyle"></tiptap-demo>
--- a/docs/api/marks/underline.md
+++ b/docs/api/marks/underline.md
@@ -0,0 +1,42 @@
+# Underline
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-underline.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-underline)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-underline.svg)](https://npmcharts.com/compare/@tiptap/extension-underline?minimal=true)
+
+Use this extension to render text <u>underlined</u>. If you pass `<u>` tags, or text with inline `style` attributes setting `text-decoration: underline` in the editor’s initial content, they all will be rendered accordingly.
+
+Be aware that underlined text in the Internet usually indicates that it’s a clickable link. Don’t confuse your users with underlined text.
+
+::: warning Restrictions
+The extension will generate the corresponding `<u>` HTML tags when reading contents of the `Editor` instance. All text marked underlined, regardless of the method will be normalized to `<u>` HTML tags.
+:::
+
+## Installation
+```bash
+# with npm
+npm install @tiptap/extension-underline
+
+# with Yarn
+yarn add @tiptap/extension-underline
+```
+
+## Settings
+| Option         | Type     | Default | Description                                                           |
+| -------------- | -------- | ------- | --------------------------------------------------------------------- |
+| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
+
+## Commands
+| Command         | Parameters | Description              |
+| --------------- | ---------- | ------------------------ |
+| setUnderline    | —          | Mark text as underlined. |
+| toggleUnderline | —          | Toggle underline mark.   |
+| unsetUnderline  | —          | Remove underline mark.   |
+
+## Keyboard shortcuts
+* Windows/Linux: `Control`&nbsp;`U`
+* macOS: `Cmd`&nbsp;`U`
+
+## Source code
+[packages/extension-underline/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-underline/)
+
+## Usage
+<tiptap-demo name="Marks/Underline"></tiptap-demo>