From 9347dd167f20c709511f84a328ec5f89f07169f2 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Wed, 28 Oct 2020 16:49:44 +0100 Subject: [PATCH] update content --- docs/src/docPages/api/extensions/collaboration.md | 6 +++++- docs/src/docPages/api/overview.md | 13 ++++++++----- docs/src/links.yaml | 5 +++++ docs/src/templates/DocPage/style.scss | 6 ++++++ 4 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/src/docPages/api/extensions/collaboration.md b/docs/src/docPages/api/extensions/collaboration.md index fa5bbab9..c19acbb7 100644 --- a/docs/src/docPages/api/extensions/collaboration.md +++ b/docs/src/docPages/api/extensions/collaboration.md @@ -1,5 +1,9 @@ # 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 ```bash diff --git a/docs/src/docPages/api/overview.md b/docs/src/docPages/api/overview.md index f7b813bb..d8ff4f5c 100644 --- a/docs/src/docPages/api/overview.md +++ b/docs/src/docPages/api/overview.md @@ -1,10 +1,13 @@ # Overview - tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). +tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). - 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. +### 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. - 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. +### 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. - [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 +[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. diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 33b15554..b68d84fa 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -183,3 +183,8 @@ link: /api/schema - title: Keyboard Shortcuts link: /api/keyboard-shortcuts + +- title: tiptap pro + items: + - title: License + link: /license diff --git a/docs/src/templates/DocPage/style.scss b/docs/src/templates/DocPage/style.scss index ab7f0b45..fc43d067 100644 --- a/docs/src/templates/DocPage/style.scss +++ b/docs/src/templates/DocPage/style.scss @@ -247,6 +247,12 @@ color: $colorRed; } + &.pro { + border-color: rgba($colorRed, 0.1); + background-color: rgba($colorRed, 0.1); + color: $colorRed; + } + .remark-container-title { font-weight: 600; }