This commit is contained in:
Philipp Kühn
2020-04-19 23:50:55 +02:00
parent 965b969f7b
commit 25a14d0ed6
5 changed files with 30 additions and 5 deletions

View File

@@ -1,5 +1,7 @@
- title: Getting Started
items:
- title: Introduction
link: /introduction/
- title: Installation
link: /installation/

View File

@@ -1,5 +1,3 @@
# 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.
Although tiptap tries to hide most of the complexity of [ProseMirror](https://ProseMirror.net/docs/), tiptap is built on top of its APIs and we strongly recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/). You'll have a better understanding of how everything works under the hood and get familiar with many terms and jargon used by tiptap.
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

@@ -0,0 +1,23 @@
# Introduction
tiptap is a <g-link to="/renderless">renderless</g-link> wrapper around [ProseMirror](https://ProseMirror.net) a toolkit for building rich-text editors that are already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
Although tiptap tries to hide most of the complexity of ProseMirror, its is built on top of its APIs and we strongly recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/). Youll have a better understanding of how everything works under the hood and get familiar with many terms and jargon used by tiptap.
## Who is using tiptap already?
- [GitLab](https://gitlab.com)
- [Statamic CMS](https://statamic.com)
- [Twill CMS](https://twill.io)
- [ApostropheCMS](https://apostrophecms.com)
- [Directus CMS](https://directus.io)
- [Nextcloud](https://apps.nextcloud.com/apps/text)
- [and many more →](https://github.com/scrumpy/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D)
## Contributing
Please see the [`CONTRIBUTING`](https://github.com/scrumpy/tiptap/blob/master/CONTRIBUTING.md) file for details.
```bash
yarn install
yarn start
```

View File

@@ -1,3 +1,3 @@
# Renderless
tiptap comes without any CSS.
The implementation of a text editor can be very specific for each use case. We dont want to tell you what a menu should look like or where it should be rendered in the DOM. Thats why tiptap is renderless and comes without any CSS. Youll have full control over markup and styling.

View File

@@ -1 +1,3 @@
# Schema
# Schema
Compared to many other editors, tiptap is based on a [schema](https://prosemirror.net/docs/guide/#schema) that defines how the content is structured. For example this allows you to define the kind of nodes that may occur in the document, and the way they can be nested.