docs: remove toc heading

This commit is contained in:
Hans Pagel 2021-09-16 16:11:03 +02:00
parent e7caee037e
commit 63d8e84451
37 changed files with 0 additions and 74 deletions

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Commands
## toc
## Introduction
The editor provides a ton of commands to programmatically add or change content or alter the selection. If you want to build your own editor you definitely want to learn more about them.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Editor
## 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.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Events
## toc
## Introduction
The editor fires a few different events that you can hook into. Lets have a look at all the available events first:

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Extensions
## toc
## Introduction
Extensions add new capabilities to tiptap and youll read the word extension here very often. Actually, there are literal Extensions. Those cant add to the schema, but can add functionality or change the behaviour of the editor.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Keyboard Shortcuts
## toc
## Introduction
tiptap comes with sensible keyboard shortcut defaults. Depending on what you want to use it for, youll probably want to change those keyboard shortcuts to your liking. Lets have a look at what we defined for you, and show you how to change it then!

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Marks
## toc
## Introduction
One or multiple marks can be applied to [nodes](/api/nodes), for example to add inline formatting like bold and italic, or other additional information.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Nodes
## toc
## Introduction
If you think of the document as a tree, then nodes are just a type of content in that tree. Examples of nodes are paragraphs, headings, or code blocks. But nodes dont have to be blocks. They can also be rendered inline with the text, for example for **@mentions**.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Schema
## 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.

View File

@ -8,8 +8,6 @@ tableOfContents: true
Using the collaborative editing commercially? [Become a sponsor](/sponsor) to fund its development!
:::
## toc
## Introduction
This example shows how you can use tiptap to let multiple users collaborate in the same document in real-time.

View File

@ -8,8 +8,6 @@ tableOfContents: true
We need your support to maintain, update, support and develop tiptap. If youre waiting for progress here, [become a sponsor and fund our work](/sponsor).
:::
## toc
## Introduction
We strive to make tiptap accessible to everyone, but to be honest, theres not much work done now. From our current understanding, thats what needs to be done:

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Collaborative editing
## toc
## Introduction
Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). The following guide explains all things to take into account when you consider to make tiptap collaborative. Dont worry, a production-grade setup doesnt require much code.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Configuration
## toc
## Introduction
For most cases its enough to say where tiptap should be rendered (`element`), what functionalities you want to enable (`extensions`) and what the initial document should be (`content`).

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Custom extensions
## toc
## Introduction
One of the strengths of tiptap is its extendability. You dont depend on the provided extensions, it is intended to extend the editor to your liking.

View File

@ -4,5 +4,3 @@ tableOfContents: true
# Overwrite & extend
## toc

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Create menus
## toc
## Introduction
tiptap comes very raw, but thats a good thing. You have full control about the appearance of it.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Interactive node views
## toc
## Introduction
Node views are the best thing since sliced bread, at least if you are a fan of customization (and bread). With node views you can add interactive nodes to your editor. That can literally be everything. If you can write it in JavaScript, you can use it in your editor.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Examples
## toc
## Introduction
Node views enable you to fully customize your nodes. We are collecting a few different examples here. Feel free to copy them and start building on them.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Node views with JavaScript
## toc
## Introduction
Using frameworks like Vue or React can feel too complex, if youre used to work without those two. Good news: You can use Vanilla JavaScript in your node views. There is just a little bit you need to know, but lets go through this one by one.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Node views with React
## toc
## Introduction
Using Vanilla JavaScript can feel complex if you are used to work in React. Good news: You can use regular React components in your node views, too. There is just a little bit you need to know, but lets go through this one by one.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Node views with Vue
## toc
## Introduction
Using Vanilla JavaScript can feel complex if you are used to work in Vue. Good news: You can use regular Vue components in your node views, too. There is just a little bit you need to know, but lets go through this one by one.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Output
## 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. Here is an interactive example, that exports the content as HTML and JSON when the document is changed:

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Styling
## toc
## Introduction
tiptap is headless, that means there is no styling provided. That also means, you are in full control of how your editor looks. The following methods allow you to apply custom styles to the editor.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Working with TypeScript
## toc
## Introduction
The whole tiptap is code base is written in TypeScript. If you havent heard of it or never used it, no worries. You dont have to.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Impressum
## toc
## Contact
Information provided according to Sec. 5 German Telemedia Act (TMG)

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Installation
## toc
## Introduction
tiptap is framework-agnostic and even works with Vanilla JavaScript (if thats your thing). The following integration guides help you integrating tiptap in your JavaScript project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Alpine.js
## toc
## Introduction
The following guide describes how to integrate tiptap with your [Alpine.js](https://github.com/alpinejs/alpine) project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Livewire
## toc
## Introduction
The following guide describes how to integrate tiptap with your [Livewire](https://laravel-livewire.com/) project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Nuxt.js
## toc
## Introduction
The following guide describes how to integrate tiptap with your [Nuxt.js](https://nuxtjs.org/) project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# React
## toc
## Introduction
The following guide describes how to integrate tiptap with your [React](https://reactjs.org/) project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Svelte
## toc
## Introduction
The following guide describes how to integrate tiptap with your [SvelteKit](https://kit.svelte.dev/) project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Vue.js 2
## toc
## Introduction
The following guide describes how to integrate tiptap with your [Vue](https://vuejs.org/) CLI project.

View File

@ -5,8 +5,6 @@ tableOfContents: true
# Vue.js 3
## toc
## Introduction
The following guide describes how to integrate tiptap with your [Vue](https://vuejs.org/) CLI project.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Introduction
## toc
## Whats tiptap?
[![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true)

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Contributing
## 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:

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Upgrade Guide
## toc
## Reasons to upgrade to tiptap 2.x
Yes, its tedious work to upgrade your favorite text editor to a new API, but we made sure youve got enough reasons to upgrade to the newest version

View File

@ -4,8 +4,6 @@ tableOfContents: true
# Privacy Policy
## toc
## Introduction
We value your privacy and question everything that stores or processes your personal information. With that in mind, we still need a few external services to publish tiptap.

View File

@ -4,8 +4,6 @@ tableOfContents: true
# About the project
## toc
## Introduction
To deliver a top-notch developer experience and user experience, we put ~~hundreds~~ thousands of hours of unpaid work into tiptap. Your funding helps us to make this work more and more financially sustainable. This enables us to provide helpful support, maintain all our packages, keep everything up to date, and develop new features and extensions for tiptap.