Merge branch 'main' of github.com:ueberdosis/tiptap-next into main

This commit is contained in:
Hans Pagel
2020-11-06 16:25:54 +01:00
13 changed files with 278 additions and 4 deletions

View File

@@ -0,0 +1,26 @@
# FontFamily
This extension enables you to set the font family in the editor.
## Installation
::: warning Use with TextStyle
This extension requires the [`TextStyle`](/api/marks/text-style) mark.
:::
```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
```
## Settings
| Option | Type | Default | Description |
| ------ | ----- | ------------- | --------------------------------------------------------------------- |
| types | array | ['textStyle'] | A list of marks where the font family attribute should be applied to. |
## Source code
[packages/extension-font-family/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-font-family/)
## Usage
<demo name="Extensions/FontFamily" highlight="" />

View File

@@ -0,0 +1,17 @@
# Text Style
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 font-color. The extension doesnt add any styling attribute by default, but other extensions use it as the foundation, for example [`FontFamily`](/api/extensions/font-family).
## Installation
```bash
# with npm
npm install @tiptap/extension-text-style
# with Yarn
yarn add @tiptap/extension-text-style
```
## Source code
[packages/extension-text-style/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text-style/)
## Usage
<demo name="Marks/TextStyle" />

View File

@@ -5,7 +5,7 @@ Type <code>*&nbsp;</code>, <code>-&nbsp;</code> or <code>+&nbsp;</code> at the b
## Installation
::: warning Use with ListItem
This extension requires the [`ListItem`](/api/nodes/list-item) extension.
This extension requires the [`ListItem`](/api/nodes/list-item) node.
:::
```bash

View File

@@ -3,7 +3,7 @@ The ListItem extension adds support for the `<li>` HTML tag. Its used for bul
## Installation
::: warning Use with BulletList and/or OrderedList
This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) extension.
This extension requires the [`BulletList`](/api/nodes/bullet-list) or [`OrderedList`](/api/nodes/ordered-list) node.
:::
```bash

View File

@@ -5,7 +5,7 @@ Type <code>1.&nbsp;</code> (or any other number followed by a dot) at the beginn
## Installation
::: warning Use with ListItem
This extension requires the [`ListItem`](/api/nodes/list-item) extension.
This extension requires the [`ListItem`](/api/nodes/list-item) node.
:::
```bash

View File

@@ -5,7 +5,7 @@ This extension doesnt require any JavaScript framework, its based on plain
## Installation
::: warning Use with TaskList
This extension requires the [`TaskList`](/api/nodes/task-list) extension.
This extension requires the [`TaskList`](/api/nodes/task-list) node.
:::
```bash