add introduction to all pages, move under table of contents

This commit is contained in:
Hans Pagel
2020-10-01 12:26:20 +02:00
parent 1250f1f1b6
commit d99b75f6dd
13 changed files with 42 additions and 13 deletions

View File

@@ -1,5 +1,9 @@
# Commands
## Table of Contents
## Introduction
## Chain commands
```js

View File

@@ -1,8 +1,10 @@
# Editor
This class is a central building block of tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on.
## Table of Contents
## Introduction
This class is a central building block of tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on.
## Configuration
| Setting | Type | Default | Description |
| ------------------ | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

View File

@@ -1,8 +1,10 @@
# Events
The editor fires a few different events that you can hook into. There are two ways to register event listeners:
## Table of Contents
## Introduction
The editor fires a few different events that you can hook into. There are two ways to register event listeners:
## Option 1: Right-away
You can define your event listeners on a new editor instance right-away:

View File

@@ -1,8 +1,10 @@
# Extensions
Extensions are the way to add functionality to tiptap. By default tiptap comes bare, without any of them, but we have a long list of extensions that are ready to be used with tiptap.
## Table of Contents
## Introduction
Extensions are the way to add functionality to tiptap. By default tiptap comes bare, without any of them, but we have a long list of extensions that are ready to be used with tiptap.
## A minimalist set of extensions
Youll need at least three extensions: `Document`, `Paragraph` and `Text`. See [an example of a tiptap version for minimalists](/examples/minimalist).

View File

@@ -1,4 +1,5 @@
# Blockquote
The Blockquote extension enables you to use the `<blockquote>` HTML tag in the editor. This is great you might have guessed to use quotes in the editor.
Type <code>>&nbsp;</code> at the beginning of a new line and it will magically transform to a blockquote.

View File

@@ -1,4 +1,8 @@
# Keyboard Shortcuts
## Table of Contents
## Introduction
Keyboard shortcuts may be strings like `'Shift-Control-Enter'`. Keys are based on the strings that can appear in `event.key`, concatenated with a `-`. There is a little tool called [keycode.info](https://keycode.info/), which shows the `event.key` interactively.
Use lowercase letters to refer to letter keys (or uppercase letters if you want shift to be held). You may use `Space` as an alias for the <code>&nbsp;</code>.
@@ -7,8 +11,6 @@ Modifiers can be given in any order. `Shift`, `Alt`, `Control` and `Cmd` are rec
You can use `Mod` as a shorthand for `Cmd` on Mac and `Control` on other platforms.
## Table of Contents
## Overwrite keyboard shortcuts
```js

View File

@@ -1,12 +1,14 @@
# Schema
## Table of Contents
## Introduction
Unlike many other editors, tiptap is based on a [schema](https://prosemirror.net/docs/guide/#schema) that defines how your content is structured. That enables you to define the kind of nodes that may occur in the document, its attributes and the way they can be nested.
This schema is *very* strict. You cant use any HTML element or attribute that is not defined in your schema.
Let me give you one example: If you paste something like `This is <strong>important</strong>` into tiptap, dont have any extension that handles `strong` tags registered, youll only see `This is important` without the strong tags.
## Table of Contents
## How a schema looks like
The most simple schema for a typical *ProseMirror* editor is looking something like that: