mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-24 19:59:02 +08:00
rename table of contents to keep the search results clean
This commit is contained in:
parent
3e2c72cc93
commit
8c3a2b7d1c
@ -1,6 +1,6 @@
|
||||
# Commands
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
The editor provides a ton of commands to programmtically add or change content or alter the selection. If you want to build your own editor you definitely want to learn more about them.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Editor
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## 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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Events
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
The editor fires a few different events that you can hook into. There are two ways to register event listeners:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Extensions
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## 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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Keyboard Shortcuts
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## 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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Schema
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## 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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Build your editor
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
In its simplest version tiptap comes very raw. There is no menu, no buttons, no styling. That’s intended. See tiptap as your building blocks to build exactly the editor you would like to have.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Collaborative editing
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Configuration
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
tiptap is all about customization. There are a ton of options to configure the behavior and functionality of the editor. Most of those settings can be set before creating the Editor. Give tiptap a JSON with all the settings you would like to overwrite.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Custom Extensions
|
||||
# Custom extensions
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
One of the strength of tiptap is it’s extendability. You don’t depend on the provided extensions, it’s intended to extend the editor to your liking. With custom extensions you can add new content types and new functionalities, on top of what already exists or on top of that.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Custom styling
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
Tiptap is renderless, that doesn’t mean there is no styling provided. You can decided how your editor should look like.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Getting started
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
tiptap is framework-agnostic and works with Vue.js and React. It even works with plain JavaScript, if that’s your thing. To keep everything as small as possible, we put the code to use tiptap with those frameworks in different packages.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Store content
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
You can store your content as a JSON object or as a good old HTML string. Both work fine. And of course, you can pass both formats to the editor to restore your content.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Contributing
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
Tiptap would be nothing without its lively community. Contributions have always been and will always be welcome. Here is a little bit you should know, before you send your contribution:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Installation
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Introduction
|
||||
You’re free to use tiptap with the framework of your choice. Depending on what you want to do, there are a few different ways to install tiptap in your project. Choose the way that fits your workflow.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Upgrade Guide
|
||||
|
||||
## Table of Contents
|
||||
## toc
|
||||
|
||||
## Reasons to upgrade to tiptap 2.x
|
||||
Yes, it’s tedious work to upgrade your favorite text editor to a new API, but we made sure you’ve got enough reasons to upgrade to the newest version
|
||||
|
@ -95,7 +95,7 @@
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
#table-of-contents {
|
||||
#toc {
|
||||
display: none;
|
||||
|
||||
& + ul {
|
||||
|
Loading…
Reference in New Issue
Block a user