docs: update content

This commit is contained in:
Hans Pagel
2021-01-25 23:17:02 +01:00
parent 126894d9d1
commit 4ec0c456a7
5 changed files with 25 additions and 11 deletions

View File

@@ -1,4 +1,4 @@
# Overview
# Concept
tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although tiptap tries to hide most of the complexity of ProseMirror, its built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage.
### Structure

View File

@@ -4,6 +4,8 @@
## Introduction
TODO
## List of supported marks
| Title | Default Extension | Source Code |
| ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- |

View File

@@ -4,6 +4,8 @@
## Introduction
TODO
## List of supported nodes
| Title | Default Extension | Source Code |
| -------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |

View File

@@ -13,6 +13,16 @@ npm install @tiptap/extension-mention
yarn add @tiptap/extension-mention
```
## Dependencies
TODO
* tippy.js
## Rendering
TODO
* @tiptap/vue
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |