This commit is contained in:
Philipp Kühn 2020-11-02 16:23:46 +01:00
commit b89e57044a
36 changed files with 193 additions and 99 deletions

View File

@ -1,11 +0,0 @@
# CodeBlockHighlight
Enables you to use the `<pre>` HTML tag with auto-detected syntax highlighting in the editor.
## Settings
*None*
## Commands
*None*
## Keyboard shortcuts
*None*

View File

@ -0,0 +1,25 @@
# Dropcursor
## Installation
```bash
# with npm
npm install @tiptap/extension-dropcursor
# with Yarn
yarn add @tiptap/extension-dropcursor
```
## Settings
*None*
## Commands
*None*
## Keyboard shortcuts
*None*
## Source code
[packages/extension-dropcursor/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-dropcursor/)
## Usage
<demo name="Extensions/Dropcursor" highlight="" />

View File

@ -0,0 +1,25 @@
# Focus
## Installation
```bash
# with npm
npm install @tiptap/extension-focus
# with Yarn
yarn add @tiptap/extension-focus
```
## Settings
*None*
## Commands
*None*
## Keyboard shortcuts
*None*
## Source code
[packages/extension-focus/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-focus/)
## Usage
<demo name="Extensions/Focus" highlight="" />

View File

@ -0,0 +1,25 @@
# Gapcursor
## Installation
```bash
# with npm
npm install @tiptap/extension-gapcursor
# with Yarn
yarn add @tiptap/extension-gapcursor
```
## Settings
*None*
## Commands
*None*
## Keyboard shortcuts
*None*
## Source code
[packages/extension-gapcursor/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-gapcursor/)
## Usage
<demo name="Extensions/Gapcursor" highlight="" />

View File

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

View File

@ -1,2 +0,0 @@
# Placeholder
Enables you to show placeholders on empty paragraphs.

View File

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

View File

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

View File

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

View File

@ -0,0 +1,17 @@
# Typography
## Installation
```bash
# with npm
npm install @tiptap/typography
# with Yarn
yarn add @tiptap/typography
```
## Source code
[packages/typography/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/typography/)
## Usage
<demo name="Extensions/Typography" highlight="" />

View File

@ -0,0 +1,5 @@
# Marks
## toc
## Introduction

View File

@ -0,0 +1,5 @@
# Nodes
## toc
## Introduction

View File

@ -3,7 +3,7 @@ The ListItem extension adds support for the `<li>` HTML tag. Its used for bul
## Installation
::: warning Restrictions
This extensions is intended to be used with the [`BulletList`](/api/extensions/bullet-list) or [`OrderedList`](/api/extensions/ordered-list) extension. It doesnt work without at least using one of them.
This extension is intended to be used with the [`BulletList`](/api/extensions/bullet-list) or [`OrderedList`](/api/extensions/ordered-list) extension. It doesnt work without at least using one of them.
:::
```bash

View File

@ -0,0 +1,28 @@
# TaskItem
## Installation
::: warning Restrictions
This extension is intended to be used with the [`TaskList`](/api/extensions/task-list) extension. It doesnt work without at least using one of them.
:::
```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
```
## Settings
| Option | Type | Default | Description |
| ------ | ------ | ------- | -------------------------------------------- |
| class | string | | Add a custom class to the rendered HTML tag. |
## Commands
*None*
## Source code
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-item/)
## Usage
<demo name="Extensions/TaskItem" />

View File

@ -8,6 +8,6 @@ ProseMirror works with a strict [Schema](/api/schema), which defines the allowed
The document is stored in a state. All changes are applied as transactions to the state. The state has details about the current content, cursor position and selection. You can hook into a few different [events](/api/events), for example to alter transactions before they get applied.
### Extensions
[Extensions](/api/extensions) add functionality like nodes, marks and/or commands to the editor. A huge amount of commands are bound to common [keyboard shortcuts](/api/keyboard-shortcuts).
Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities](/api/extensions) to the editor. A lot of those extensions bound their commands to common [keyboard shortcuts](/api/keyboard-shortcuts).
All those concepts are explained in detail on the following pages.

View File

@ -104,22 +104,58 @@
link: /api/overview
- title: Editor
link: /api/editor
- title: Nodes
link: /api/nodes
items:
- title: Blockquote
link: /api/nodes/blockquote
- title: BulletList
link: /api/nodes/bullet-list
- title: CodeBlock
link: /api/nodes/code-block
- title: Document
link: /api/nodes/document
- title: HardBreak
link: /api/nodes/hard-break
- title: Heading
link: /api/nodes/heading
- title: HorizontalRule
link: /api/nodes/horizontal-rule
- title: Image
link: /api/nodes/image
draft: true
- title: ListItem
link: /api/nodes/list-item
- title: OrderedList
link: /api/nodes/ordered-list
- title: Paragraph
link: /api/nodes/paragraph
- title: TaskList
link: /api/nodes/task-list
draft: true
- title: TaskItem
link: /api/nodes/task-item
draft: true
- title: Text
link: /api/nodes/text
- title: Marks
link: /api/marks
items:
- title: Bold
link: /api/marks/bold
- title: Code
link: /api/marks/code
- title: Italic
link: /api/marks/italic
- title: Link
link: /api/marks/link
- title: Strike
link: /api/marks/strike
- title: Underline
link: /api/marks/underline
- title: Extensions
link: /api/extensions
items:
- title: Blockquote
link: /api/extensions/blockquote
- title: Bold
link: /api/extensions/bold
- title: BulletList
link: /api/extensions/bullet-list
- title: Code
link: /api/extensions/code
- title: CodeBlock
link: /api/extensions/code-block
# - title: CodeBlockHighlight
# link: /api/extensions/code-block-highlight
# draft: true
- title: Collaboration
link: /api/extensions/collaboration
premium: true
@ -127,62 +163,23 @@
link: /api/extensions/collaboration-cursor
draft: true
premium: true
- title: Document
link: /api/extensions/document
- title: HardBreak
link: /api/extensions/hard-break
- title: Heading
link: /api/extensions/heading
- title: Dropcursor
link: /api/extensions/dropcursor
draft: true
- title: Focus
link: /api/extensions/focus
draft: true
- title: Gapcursor
link: /api/extensions/gapcursor
draft: true
- title: History
link: /api/extensions/history
- title: HorizontalRule
link: /api/extensions/horizontal-rule
- title: Image
link: /api/extensions/image
draft: true
- title: Italic
link: /api/extensions/italic
- title: Link
link: /api/extensions/link
- title: ListItem
link: /api/extensions/list-item
# - title: Mention
# link: /api/extensions/mention
# draft: true
- title: OrderedList
link: /api/extensions/ordered-list
- title: Paragraph
link: /api/extensions/paragraph
# - title: Placeholder
# link: /api/extensions/placeholder
# draft: true
- title: Strike
link: /api/extensions/strike
- title: TaskList
link: /api/extensions/task-list
draft: true
# - title: TableCell
# link: /api/extensions/table-cell
# draft: true
# - title: TableHeader
# link: /api/extensions/table-header
# draft: true
# - title: TableRow
# link: /api/extensions/table-row
# draft: true
- title: Text
link: /api/extensions/text
- title: TextAlign
link: /api/extensions/text-align
draft: true
# - title: TodoItem
# link: /api/extensions/todo-item
# draft: true
# - title: TodoList
# link: /api/extensions/todo-list
# draft: true
- title: Underline
link: /api/extensions/underline
- title: Typography
link: /api/extensions/typography
draft: true
- title: Commands
link: /api/commands
- title: Events