docs: remove Yarn instructions

This commit is contained in:
Hans Pagel
2021-11-09 11:56:27 +01:00
parent 345abcc00c
commit 7e476ec617
55 changed files with 33 additions and 271 deletions

View File

@@ -13,10 +13,7 @@ As always, the markup and styling is totally up to you.
## Installation
```bash
# with npm
npm install @tiptap/extension-bubble-menu
# with Yarn
yarn add @tiptap/extension-bubble-menu
```
## Settings

View File

@@ -11,11 +11,7 @@ The `CharacterCount` extension limits the number of allowed character to a speci
## Installation
```bash
# with npm
npm install @tiptap/extension-character-count
# with Yarn
yarn add @tiptap/extension-character-count
```
## Settings

View File

@@ -17,11 +17,7 @@ We kindly ask you to [sponsor our work](/sponsor) when using this extension in p
## Installation
```bash
# with npm
npm install @tiptap/extension-collaboration-cursor
# with Yarn
yarn add @tiptap/extension-collaboration-cursor
```
This extension requires the [`Collaboration`](/api/extensions/collaboration) extension.

View File

@@ -17,11 +17,7 @@ We kindly ask you to [sponsor our work](/sponsor) when using this extension in p
## Installation
```bash
# with npm
npm install @tiptap/extension-collaboration yjs y-websocket
# with Yarn
yarn add @tiptap/extension-collaboration yjs y-websocket
```
## Settings

View File

@@ -11,11 +11,7 @@ This extension enables you to set the font color in the editor. It uses the [`Te
## Installation
```bash
# with npm
npm install @tiptap/extension-text-style @tiptap/extension-color
# with Yarn
yarn add @tiptap/extension-text-style @tiptap/extension-color
```
This extension requires the [`TextStyle`](/api/marks/text-style) mark.

View File

@@ -13,11 +13,7 @@ Note that Tiptap is headless, but the dropcursor needs CSS for its appearance. T
## Installation
```bash
# with npm
npm install @tiptap/extension-dropcursor
# with Yarn
yarn add @tiptap/extension-dropcursor
```
## Settings

View File

@@ -11,10 +11,7 @@ This extension will make a contextual menu appear near a selection of text.
## Installation
```bash
# with npm
npm install @tiptap/extension-floating-menu
# with Yarn
yarn add @tiptap/extension-floating-menu
```
## Settings

View File

@@ -13,11 +13,7 @@ Note that its only a class, the styling is totally up to you. The usage examp
## Installation
```bash
# with npm
npm install @tiptap/extension-focus
# with Yarn
yarn add @tiptap/extension-focus
```
## Settings

View File

@@ -10,11 +10,7 @@ This extension enables you to set the font family in the editor. It uses the [`T
## Installation
```bash
# with npm
npm install @tiptap/extension-text-style @tiptap/extension-font-family
# with Yarn
yarn add @tiptap/extension-text-style @tiptap/extension-font-family
```
This extension requires the [`TextStyle`](/api/marks/text-style) mark.

View File

@@ -13,11 +13,7 @@ Note that Tiptap is headless, but the gapcursor needs CSS for its appearance. Th
## Installation
```bash
# with npm
npm install @tiptap/extension-gapcursor
# with Yarn
yarn add @tiptap/extension-gapcursor
```
## Source code

View File

@@ -11,11 +11,7 @@ This extension provides history support. All changes to the document will be tra
## Installation
```bash
# with npm
npm install @tiptap/extension-history
# with Yarn
yarn add @tiptap/extension-history
```
## Settings

View File

@@ -11,11 +11,7 @@ This extension provides placeholder support. Give your users an idea what they s
## Installation
```bash
# with npm
npm install @tiptap/extension-placeholder
# with Yarn
yarn add @tiptap/extension-placeholder
```
## Settings

View File

@@ -11,11 +11,7 @@ The `StarterKit` is a collection of the most popular Tiptap extensions. If you
## Installation
```bash
# with npm
npm install @tiptap/starter-kit
# with Yarn
yarn add @tiptap/starter-kit
```
## Included extensions

View File

@@ -15,11 +15,7 @@ This extension adds a text align attribute to a specified list of nodes. The att
## Installation
```bash
# with npm
npm install @tiptap/extension-text-align
# with Yarn
yarn add @tiptap/extension-text-align
```
## Settings

View File

@@ -11,11 +11,7 @@ This extension tries to help with common text patterns with the correct typograp
## Installation
```bash
# with npm
npm install @tiptap/extension-typography
# with Yarn
yarn add @tiptap/extension-typography
```
## Rules

View File

@@ -17,11 +17,7 @@ The extension will generate the corresponding `<strong>` HTML tags when reading
## Installation
```bash
# with npm
npm install @tiptap/extension-bold
# with Yarn
yarn add @tiptap/extension-bold
```
## Settings

View File

@@ -13,11 +13,7 @@ Type something with <code>\`back-ticks around\`</code> and it will magically tra
## Installation
```bash
# with npm
npm install @tiptap/extension-code
# with Yarn
yarn add @tiptap/extension-code
```
## Settings

View File

@@ -13,11 +13,7 @@ Type `==two equal signs==` and it will magically transform to <mark>highlighted<
## Installation
```bash
# with npm
npm install @tiptap/extension-highlight
# with Yarn
yarn add @tiptap/extension-highlight
```
## Settings

View File

@@ -17,11 +17,7 @@ The extension will generate the corresponding `<em>` HTML tags when reading cont
## Installation
```bash
# with npm
npm install @tiptap/extension-italic
# with Yarn
yarn add @tiptap/extension-italic
```
## Settings

View File

@@ -15,11 +15,7 @@ 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

View File

@@ -17,11 +17,7 @@ The extension will generate the corresponding `<s>` HTML tags when reading conte
## Installation
```bash
# with npm
npm install @tiptap/extension-strike
# with Yarn
yarn add @tiptap/extension-strike
```
## Settings

View File

@@ -11,11 +11,7 @@ Use this extension to render text in <sub>subscript</sub>. If you pass `<sub>` o
## Installation
```bash
# with npm
npm install @tiptap/extension-subscript
# with Yarn
yarn add @tiptap/extension-subscript
```
## Settings

View File

@@ -11,11 +11,7 @@ Use this extension to render text in <sup>superscript</sup>. If you pass `<sup>`
## Installation
```bash
# with npm
npm install @tiptap/extension-superscript
# with Yarn
yarn add @tiptap/extension-superscript
```
## Settings

View File

@@ -11,11 +11,7 @@ This mark renders a `<span>` HTML tag and enables you to add a list of styling r
## Installation
```bash
# with npm
npm install @tiptap/extension-text-style
# with Yarn
yarn add @tiptap/extension-text-style
```
## Commands

View File

@@ -17,11 +17,7 @@ The extension will generate the corresponding `<u>` HTML tags when reading conte
## Installation
```bash
# with npm
npm install @tiptap/extension-underline
# with Yarn
yarn add @tiptap/extension-underline
```
## Settings

View File

@@ -13,11 +13,7 @@ Type <code>>&nbsp;</code> at the beginning of a new line and it will magically t
## Installation
```bash
# with npm
npm install @tiptap/extension-blockquote
# with Yarn
yarn add @tiptap/extension-blockquote
```
## Settings

View File

@@ -13,11 +13,7 @@ Type <code>*&nbsp;</code>, <code>-&nbsp;</code> or <code>+&nbsp;</code> at the b
## Installation
```bash
# with npm
npm install @tiptap/extension-bullet-list @tiptap/extension-list-item
# with Yarn
yarn add @tiptap/extension-bullet-list @tiptap/extension-list-item
```
This extension requires the [`ListItem`](/api/nodes/list-item) node.

View File

@@ -13,11 +13,7 @@ Type <code>&grave;&grave;&grave;&nbsp;</code> (three backticks and a space) or <
## Installation
```bash
# with npm
npm install @tiptap/extension-code-block-lowlight
# with Yarn
yarn add @tiptap/extension-code-block-lowlight
```
## Settings

View File

@@ -17,11 +17,7 @@ The CodeBlock extension doesnt come with styling and has no syntax highlighti
## Installation
```bash
# with npm
npm install @tiptap/extension-code-block
# with Yarn
yarn add @tiptap/extension-code-block
```
## Settings

View File

@@ -17,11 +17,7 @@ tiptap 1 tried to hide that node from you, but it has always been there. You hav
## Installation
```bash
# with npm
npm install @tiptap/extension-document
# with Yarn
yarn add @tiptap/extension-document
```
## Source code

View File

@@ -11,11 +11,7 @@ The HardBreak extensions adds support for the `<br>` HTML tag, which forces a li
## Installation
```bash
# with npm
npm install @tiptap/extension-hard-break
# with Yarn
yarn add @tiptap/extension-hard-break
```
## Settings

View File

@@ -13,11 +13,7 @@ Type <code>#&nbsp;</code> at the beginning of a new line and it will magically t
## Installation
```bash
# with npm
npm install @tiptap/extension-heading
# with Yarn
yarn add @tiptap/extension-heading
```
## Settings

View File

@@ -13,11 +13,7 @@ Type three dashes (<code>---</code>) or three underscores and a space (<code>___
## Installation
```bash
# with npm
npm install @tiptap/extension-horizontal-rule
# with Yarn
yarn add @tiptap/extension-horizontal-rule
```
## Settings

View File

@@ -15,11 +15,7 @@ This extension does only the rendering of images. It doesnt upload images to
## Installation
```bash
# with npm
npm install @tiptap/extension-image
# with Yarn
yarn add @tiptap/extension-image
```
## Settings

View File

@@ -11,11 +11,7 @@ The ListItem extension adds support for the `<li>` HTML tag. Its used for bul
## Installation
```bash
# with npm
npm install @tiptap/extension-list-item
# with Yarn
yarn add @tiptap/extension-list-item
```
This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.

View File

@@ -13,22 +13,14 @@ Literally everything can be customized. You can pass a custom component for the
## Installation
```bash
# with npm
npm install @tiptap/extension-mention
# with Yarn
yarn add @tiptap/extension-mention
```
## Dependencies
To place the popups correctly, were using [tippy.js](https://atomiks.github.io/tippyjs/) in all our examples. You are free to bring your own library, but if youre fine with it, just install what we use:
```bash
# with npm
npm install tippy.js
# with Yarn
yarn add tippy.js
```
## Settings

View File

@@ -13,11 +13,7 @@ Type <code>1.&nbsp;</code> (or any other number followed by a dot) at the beginn
## Installation
```bash
# with npm
npm install @tiptap/extension-ordered-list @tiptap/extension-list-item
# with Yarn
yarn add @tiptap/extension-ordered-list @tiptap/extension-list-item
```
This extension requires the [`ListItem`](/api/nodes/list-item) node.

View File

@@ -15,11 +15,7 @@ tiptap 1 tried to hide that node from you, but it has always been there. You hav
## Installation
```bash
# with npm
npm install @tiptap/extension-paragraph
# with Yarn
yarn add @tiptap/extension-paragraph
```
## Settings

View File

@@ -11,11 +11,7 @@ Dont try to use tables without table cells. It wont be fun.
## Installation
```bash
# with npm
npm install @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
# with Yarn
yarn add @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
```
This extension requires the [`Table`](/api/nodes/table), [`TableRow`](/api/nodes/table-row) and [`TableHeader`](/api/nodes/table-header) nodes.

View File

@@ -27,11 +27,7 @@ TableRow.extend({
## Installation
```bash
# with npm
npm install @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
# with Yarn
yarn add @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
```
This extension requires the [`Table`](/api/nodes/table), [`TableRow`](/api/nodes/table-row) and [`TableCell`](/api/nodes/table-cell) nodes.

View File

@@ -11,11 +11,7 @@ Whats a table without rows? Add this extension to make your tables usable.
## Installation
```bash
# with npm
npm install @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
# with Yarn
yarn add @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
```
This extension requires the [`Table`](/api/nodes/table), [`TableHeader`](/api/nodes/table-header) and [`TableCell`](/api/nodes/table-cell) nodes.

View File

@@ -16,11 +16,7 @@ Dont forget to add a `spacer.gif`. (Just joking. If you dont know what tha
## Installation
```bash
# with npm
npm install @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
# with Yarn
yarn add @tiptap/extension-table @tiptap/extension-table-row @tiptap/extension-table-header @tiptap/extension-table-cell
```
This extension requires the [`TableRow`](/api/nodes/table-row), [`TableHeader`](/api/nodes/table-header) and [`TableCell`](/api/nodes/table-cell) nodes.

View File

@@ -13,11 +13,7 @@ This extension doesnt require any JavaScript framework, its based on Vanil
## Installation
```bash
# With npm
npm install @tiptap/extension-task-list @tiptap/extension-task-item
# Or: With Yarn
yarn add @tiptap/extension-task-list @tiptap/extension-task-item
```
This extension requires the [`TaskList`](/api/nodes/task-list) node.

View File

@@ -13,11 +13,7 @@ Type <code>[ ]&nbsp;</code> or <code>[x]&nbsp;</code> at the beginning of a new
## Installation
```bash
# with npm
npm install @tiptap/extension-task-list @tiptap/extension-task-item
# with Yarn
yarn add @tiptap/extension-task-list @tiptap/extension-task-item
```
This extension requires the [`TaskItem`](/api/nodes/task-item) extension.

View File

@@ -15,11 +15,7 @@ tiptap 1 tried to hide that node from you, but it has always been there. You hav
## Installation
```bash
# with npm
npm install @tiptap/extension-text
# with Yarn
yarn add @tiptap/extension-text
```
## Source code