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

improve the extensions documentation

Browse Source
This commit is contained in:
Hans Pagel
2020-08-20 15:33:16 +02:00
parent f8a5079b2b
commit cbe8e1f357
26 changed files with 108 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/src/docPages/api/extensions/blockquote.md
View File

@@ -1,18 +1,18 @@
# Blockquote
Allows you to use the `<blockquote>` HTML tag in the editor.
The Blockquote extension enables you to use the `<blockquote>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| blockquote | none | Wrap content in a blockquote. |
#### Keybindings
## Keybindings
* `Control` + `→`
#### Example
## Usage
```markup
<template>
<div>

14
docs/src/docPages/api/extensions/bold.md
View File

@@ -1,23 +1,23 @@
# Bold
Renders text in **bold** text weight. If you pass `<strong>`, or `<b>` tags, or text with inline `style` attributes setting the `font-weight` CSS rule in the editor's initial content, they will be rendered accordingly.
Renders text in **bold** text weight. 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.
::: warning Restrictions
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked as bold, regardless of method will be normalized to `<strong>` HTML tags.
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked as bold, regardless of the method will be normalized to `<strong>` HTML tags.
:::
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| bold | none | Mark text as bold. |
#### Keybindings
## Keybindings
* Windows & Linux: `Control` + `B`
* macOS: `Command` + `B`
#### Example
## Usage
```markup
<template>

14
docs/src/docPages/api/extensions/bulletlist.md
View File

@@ -1,22 +1,22 @@
# BulletList
Allows you to use the `<ul>` HTML tag in the editor.
This extension enables you to use the `<ul>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `ListItem` extension.
It’s intended to be used with the `ListItem` extension.
:::
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| bullet_list | none | Toggle a bullet list. |
#### Keybindings
## Keybindings
* `Control` + `Shift` + `8`
#### Example
## Usage
```markup
<template>

12
docs/src/docPages/api/extensions/code.md
View File

@@ -1,18 +1,18 @@
# Code
Allows you to use the `<code>` HTML tag in the editor.
The Code extensions enables you to use the `<code>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| code | none | Mark text as code. |
#### Keybindings
## Keybindings
* `Alt` + `
#### Example
## Usage
```markup
<template>
<div>

18
docs/src/docPages/api/extensions/codeblock.md
View File

@@ -1,18 +1,2 @@
# CodeBlock
Allows you to use the `<pre>` HTML tag in the editor.
## CodeBlockHighlight
Allows you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.
## Collaboration
Allows you to collaborate with others on one document.
## HardBreak
Allows you to use the `<br>` HTML tag in the editor.
#### Options
*None*
#### Keybindings
* New CodeBlock: `Shift` + `Enter` + `
* Leave CodeBlock: `Command` + `Enter`
Enables you to use the `<pre>` HTML tag in the editor.

2
docs/src/docPages/api/extensions/codeblockheighlight.md Normal file
View File

@@ -0,0 +1,2 @@
# CodeBlockHighlight
Enables you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.

2
docs/src/docPages/api/extensions/collaboration.md Normal file
View File

@@ -0,0 +1,2 @@
# Collaboration
Enables you to collaborate with others on one document.

9
docs/src/docPages/api/extensions/hardbreak.md Normal file
View File

@@ -0,0 +1,9 @@
# HardBreak
Enables you to use the `<br>` HTML tag in the editor.
## Options
*None*
## Keybindings
* New CodeBlock: `Shift` + `Enter` + `
* Leave CodeBlock: `Command` + `Enter`

12
docs/src/docPages/api/extensions/heading.md
View File

@@ -1,17 +1,17 @@
# Heading
Allows you to use the headline HTML tags in the editor.
Enables you to use the headline HTML tags in the editor.
#### Options
## Options
| option | type | default | description |
| ------ | ---- | ---- | ----- |
| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are to be supported. |
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| heading | level | Creates a heading node. |
#### Keybindings
## Keybindings
* `Control` + `Shift` + `1` → H1
* `Control` + `Shift` + `2` → H2
* `Control` + `Shift` + `3` → H3
@@ -19,7 +19,7 @@ Allows you to use the headline HTML tags in the editor.
* `Control` + `Shift` + `5` → H5
* `Control` + `Shift` + `6` → H6
#### Example
## Usage
```markup
<template>
<div>

8
docs/src/docPages/api/extensions/history.md
View File

@@ -1,19 +1,19 @@
# History
Enables history support.
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| undo | none | Undo the latest change. |
| redo | none | Redo the latest change. |
#### Keybindings
## Keybindings
* Windows & Linux: `Control` + `Z` → Undo
* Windows & Linux: `Shift` + `Control` + `Z` → Redo
* macOS: `Command` + `Z` → Undo
* macOS: `Shift` + `Command` + `Z` → Redo
#### Example
## Usage
```markup
<template>
<div>

12
docs/src/docPages/api/extensions/horizontalrule.md
View File

@@ -1,18 +1,18 @@
# HorizontalRule
Allows you to use the `<hr>` HTML tag in the editor.
Enables you to use the `<hr>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| horizontal_rule | none | Create a horizontal rule. |
#### Keybindings
## Keybindings
*None*
#### Example
## Usage
```markup
<template>
<div>

12
docs/src/docPages/api/extensions/italic.md
View File

@@ -1,19 +1,19 @@
# Italic
Allows you to use the `<em>` HTML tag in the editor.
Enables you to use the `<em>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| italic | none | Mark text as italic. |
#### Keybindings
## Keybindings
* Windows & Linux: `Control` + `I`
* macOS: `Command` + `I`
#### Example
## Usage
```markup
<template>
<div>

4
docs/src/docPages/api/extensions/link.md
View File

@@ -1,7 +1,7 @@
# Link
Allows you to use the `<a>` HTML tag in the editor.
Enables you to use the `<a>` HTML tag in the editor.
#### Options
## Options
| option | type | default | description |
| ------ | ---- | ---- | ----- |
| openOnClick | Boolean | true | Specifies if links will be opened on click. |

2
docs/src/docPages/api/extensions/listitem.md
View File

@@ -1,5 +1,5 @@
# ListItem
Allows you to use the `<li>` HTML tag in the editor.
Enables you to use the `<li>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `BulletList` or `OrderedList` extension.

2
docs/src/docPages/api/extensions/mention.md
View File

@@ -1,2 +1,2 @@
## Mention
Allows you to use mentions in the editor.
Enables you to use mentions in the editor.

12
docs/src/docPages/api/extensions/orderedlist.md
View File

@@ -1,22 +1,22 @@
# OrderedList
Allows you to use the `<ol>` HTML tag in the editor.
Enables you to use the `<ol>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `ListItem` extension.
:::
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| ordered_list | none | Toggle an ordered list. |
#### Keybindings
## Keybindings
* `Control` + `Shift` + `9`
#### Example
## Usage
```markup
<template>
<div>

12
docs/src/docPages/api/extensions/placeholder.md
View File

@@ -1,22 +1,22 @@
# Placeholder
Allows you to show placeholders on empty paragraphs.
Enables you to show placeholders on empty paragraphs.
## Table
This enables support for tables in your editor.
Tables can be nested and allow all blocks to be used inside.
Each `<TableCell>` includes a single `<Paragraph>`.
#### Options
## Options
| option | type | default | description |
| ------ | ---- | ---- | ----- |
| resizable | Boolean | false | Enables the resizing of columns |
#### Keybindings
## Keybindings
* `Tab` → Next Cell
* `Shift` + `Tab` + ` → Previous Cell
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| createTable | ```{ rowsCount, colsCount, withHeaderRow }``` | Returns a table node of a given size. `withHeaderRow` defines whether the first row of the table will be a header row. |
| deleteTable | none | Deletes the complete table which is active |
@@ -34,7 +34,7 @@ Each `<TableCell>` includes a single `<Paragraph>`.
| setCellAttr | none | Returns a command that sets the given attribute to the given value, and is only available when the currently selected cell doesn't already have that attribute set to that value. |
| fixTables | none | Inspect all tables in the given state's document and return a transaction that fixes them, if necessary. |
#### Example
## Usage
::: warning
You have to include all table extensions (`TableHeader`, `TableCell` & `TableRow`)
:::

12
docs/src/docPages/api/extensions/strike.md
View File

@@ -1,19 +1,19 @@
# Strike
Allows you to use the `<s>` HTML tag in the editor.
Enables you to use the `<s>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| strike | none | Mark text as strikethrough. |
#### Keybindings
## Keybindings
* Windows & Linux: `Control` + `D`
* macOS: `Command` + `D`
#### Example
## Usage
```markup
<template>

2
docs/src/docPages/api/extensions/tablecell.md
View File

@@ -1,5 +1,5 @@
# TableCell
Allows you to use the `<td>` HTML tag in the editor.
Enables you to use the `<td>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `Table` extension.

2
docs/src/docPages/api/extensions/tableheader.md
View File

@@ -1,5 +1,5 @@
# TableHeader
Allows you to use the `<th>` HTML tag in the editor.
Enables you to use the `<th>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `Table` extension.

2
docs/src/docPages/api/extensions/tablerow.md
View File

@@ -1,5 +1,5 @@
# TableRow
Allows you to use the `<tr>` HTML tag in the editor.
Enables you to use the `<tr>` HTML tag in the editor.
::: warning Restrictions
This extensions is intended to be used with the `Table` extension.

6
docs/src/docPages/api/extensions/todoitem.md
View File

@@ -5,13 +5,13 @@ It renders a single toggleable item of a list.
This extensions is intended to be used with the `TodoList` extension.
:::
#### Options
## Options
| option | type | default | description |
| ------ | ---- | ---- | ----- |
| nested | Boolean | false | Specifies if you can nest todo lists. |
#### Commands
## Commands
*None*
#### Keybindings
## Keybindings
*None*

10
docs/src/docPages/api/extensions/todolist.md
View File

@@ -5,18 +5,18 @@ Renders a toggleable list of items.
This extensions is intended to be used with the `TodoItem` extension.
:::
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| todo_list | none | Toggle todo list. |
#### Keybindings
## Keybindings
*None*
#### Example
## Usage
```markup
<template>
<div>

12
docs/src/docPages/api/extensions/underline.md
View File

@@ -1,19 +1,19 @@
# Underline
Allows you to use the `<u>` HTML tag in the editor.
Enables you to use the `<u>` HTML tag in the editor.
#### Options
## Options
*None*
#### Commands
| command | options | description |
## Commands
| Command | Options | Description |
| ------ | ---- | ---------------- |
| underline | none | Mark text as underlined. |
#### Keybindings
## Keybindings
* Windows & Linux: `Control` + `U`
* macOS: `Command` + `U`
#### Example
## Usage
```markup
<template>