docs: update content
This commit is contained in:
@@ -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, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage.
|
tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although tiptap tries to hide most of the complexity of ProseMirror, it’s 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
|
### Structure
|
||||||
@@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
## List of supported marks
|
## List of supported marks
|
||||||
| Title | Default Extension | Source Code |
|
| Title | Default Extension | Source Code |
|
||||||
| ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- |
|
| ---------------------------------- | ----------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
|||||||
@@ -4,6 +4,8 @@
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
## List of supported nodes
|
## List of supported nodes
|
||||||
| Title | Default Extension | Source Code |
|
| Title | Default Extension | Source Code |
|
||||||
| -------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
|
|||||||
@@ -13,6 +13,16 @@ npm install @tiptap/extension-mention
|
|||||||
yarn add @tiptap/extension-mention
|
yarn add @tiptap/extension-mention
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
TODO
|
||||||
|
|
||||||
|
* tippy.js
|
||||||
|
|
||||||
|
## Rendering
|
||||||
|
TODO
|
||||||
|
|
||||||
|
* @tiptap/vue
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
| Option | Type | Default | Description |
|
| Option | Type | Default | Description |
|
||||||
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
|
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
|
||||||
|
|||||||
@@ -44,7 +44,7 @@
|
|||||||
- title: Getting started
|
- title: Getting started
|
||||||
link: /guide/getting-started
|
link: /guide/getting-started
|
||||||
items:
|
items:
|
||||||
- title: Vue CLI
|
- title: Vue.js 2
|
||||||
link: /guide/getting-started/vue-cli
|
link: /guide/getting-started/vue-cli
|
||||||
skip: true
|
skip: true
|
||||||
- title: Nuxt.js
|
- title: Nuxt.js
|
||||||
@@ -100,10 +100,12 @@
|
|||||||
|
|
||||||
- title: API
|
- title: API
|
||||||
items:
|
items:
|
||||||
- title: Overview
|
- title: Concept
|
||||||
link: /api/overview
|
link: /api/overview
|
||||||
- title: Editor
|
- title: Editor
|
||||||
link: /api/editor
|
link: /api/editor
|
||||||
|
- title: Commands
|
||||||
|
link: /api/commands
|
||||||
- title: Nodes
|
- title: Nodes
|
||||||
link: /api/nodes
|
link: /api/nodes
|
||||||
items:
|
items:
|
||||||
@@ -201,20 +203,18 @@
|
|||||||
link: /api/extensions/text-align
|
link: /api/extensions/text-align
|
||||||
- title: Typography
|
- title: Typography
|
||||||
link: /api/extensions/typography
|
link: /api/extensions/typography
|
||||||
- title: Commands
|
|
||||||
link: /api/commands
|
|
||||||
- title: Events
|
|
||||||
link: /api/events
|
|
||||||
- title: Schema
|
|
||||||
link: /api/schema
|
|
||||||
- title: Keyboard Shortcuts
|
|
||||||
link: /api/keyboard-shortcuts
|
|
||||||
- title: Utilities
|
- title: Utilities
|
||||||
link: /api/utilities
|
link: /api/utilities
|
||||||
redirect: /api/utilities/suggestion
|
redirect: /api/utilities/suggestion
|
||||||
items:
|
items:
|
||||||
- title: Suggestion
|
- title: Suggestion
|
||||||
link: /api/utilities/suggestion
|
link: /api/utilities/suggestion
|
||||||
|
- title: Events
|
||||||
|
link: /api/events
|
||||||
|
- title: Schema
|
||||||
|
link: /api/schema
|
||||||
|
- title: Keyboard Shortcuts
|
||||||
|
link: /api/keyboard-shortcuts
|
||||||
|
|
||||||
- title: Links
|
- title: Links
|
||||||
items:
|
items:
|
||||||
|
|||||||
Reference in New Issue
Block a user