ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update content

Browse Source
This commit is contained in:
Hans Pagel
2020-10-28 16:49:44 +01:00
parent 0d1bf1da67
commit 9347dd167f
4 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/docPages/api/extensions/collaboration.md
View File

@@ -1,5 +1,9 @@
# Collaboration # Collaboration
Enables you to collaborate with others on one document. The Collaboration extension enables you to collaborate with others on one document. The implementation is based on [Y.js by Kevin Jahns](https://github.com/yjs/yjs), which is the coolest thing to [integrate collaborative editing](/guide/collaborative-editing) in your project.
:::pro Premium Extension
Using this in production requires a **tiptap pro** license. [Read more](/license)
:::
## Installation ## Installation
```bash ```bash

5
docs/src/docPages/api/overview.md
View File

@@ -1,10 +1,13 @@
# Overview # Overview
tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net).
### Structure
ProseMirror works with a strict [Schema](/api/schema), which defines the allowed structure of a document. A document is a tree of headings, paragraphs and others elements, so called nodes. Marks can be attached to a node, e. g. to emphasize part of it. [Commands](/api/commands) change that document programmatically. ProseMirror works with a strict [Schema](/api/schema), which defines the allowed structure of a document. A document is a tree of headings, paragraphs and others elements, so called nodes. Marks can be attached to a node, e. g. to emphasize part of it. [Commands](/api/commands) change that document programmatically.
### Content
The document is stored in a state. All changes are applied as transactions to the state. The state has details about the current content, cursor position and selection. You can hook into a few different [events](/api/events), for example to alter transactions before they get applied. The document is stored in a state. All changes are applied as transactions to the state. The state has details about the current content, cursor position and selection. You can hook into a few different [events](/api/events), for example to alter transactions before they get applied.
### Extensions
[Extensions](/api/extensions) add functionality like nodes, marks and/or commands to the editor. A huge amount of commands are bound to common [keyboard shortcuts](/api/keyboard-shortcuts). [Extensions](/api/extensions) add functionality like nodes, marks and/or commands to the editor. A huge amount of commands are bound to common [keyboard shortcuts](/api/keyboard-shortcuts).
All of those concepts are explained in detail on the following pages. All those concepts are explained in detail on the following pages.

5
docs/src/links.yaml
View File

@@ -183,3 +183,8 @@
link: /api/schema link: /api/schema
- title: Keyboard Shortcuts - title: Keyboard Shortcuts
link: /api/keyboard-shortcuts link: /api/keyboard-shortcuts
- title: tiptap pro
items:
- title: License
link: /license

6
docs/src/templates/DocPage/style.scss
View File

@@ -247,6 +247,12 @@
color: $colorRed; color: $colorRed;
} }
&.pro {
border-color: rgba($colorRed, 0.1);
background-color: rgba($colorRed, 0.1);
color: $colorRed;
}
.remark-container-title { .remark-container-title {
font-weight: 600; font-weight: 600;
} }