From f05e23734624535e795ef0f144ac0000dc95dc0d Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Thu, 15 Apr 2021 19:33:51 +0200 Subject: [PATCH] docs: update content --- docs/src/docPages/api/concept.md | 22 +++++++++---------- docs/src/docPages/api/marks.md | 2 +- docs/src/docPages/api/nodes.md | 2 +- ...ock-language.md => syntax-highlighting.md} | 2 +- docs/src/links.yaml | 10 ++------- 5 files changed, 16 insertions(+), 22 deletions(-) rename docs/src/docPages/examples/{code-block-language.md => syntax-highlighting.md} (66%) diff --git a/docs/src/docPages/api/concept.md b/docs/src/docPages/api/concept.md index 4d26a5eb..d1ba2d09 100644 --- a/docs/src/docPages/api/concept.md +++ b/docs/src/docPages/api/concept.md @@ -13,14 +13,14 @@ Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities] ## Vocabulary ProseMirror has its own vocabulary and you’ll stumble upon all those words now and then. Here is a short overview of the most common words we use in the documentation. -| Word | Description | -| ----------- | ------------------------------------------------------------------------ | -| Schema | Configures the structure your content can have. | -| Document | The actual content in your editor. | -| State | Everything to describe the current content and selection of your editor. | -| Transaction | A change to the state (updated selection, content, …) | -| Extension | Registeres new functionality. | -| Node | Adds blocks, like heading, paragraph. | -| Mark | Adds inline formatting, for example bold or italic. | -| Command | Execute an action inside the editor, that somehow changes the state. | -| Decoration | Styling on top of the document, for example to highlight mistakes. | +| Word | Description | +| ----------- | --------------------------------------------------------------------------------- | +| Schema | Configures the structure your content can have. | +| Document | The actual content in your editor. | +| State | Everything to describe the current content and selection of your editor. | +| Transaction | A change to the state (updated selection, content, …) | +| Extension | Registeres new functionality. | +| Node | Nodes are a type of content, for example a heading or a paragraph. | +| Mark | One or multiple marks can be applied to nodes, for example for inline formatting. | +| Command | Execute an action inside the editor, that somehow changes the state. | +| Decoration | Styling on top of the document, for example to highlight mistakes. | diff --git a/docs/src/docPages/api/marks.md b/docs/src/docPages/api/marks.md index 840e9c13..6d30a27a 100644 --- a/docs/src/docPages/api/marks.md +++ b/docs/src/docPages/api/marks.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Marks add new capabilities to tiptap. Marks are like different types of inline styling, for example bold, italic or highlights. +One or multiple marks can be applied to [nodes](/api/nodes), for example to add inline formatting like bold and italic, or other additional information. ## List of supported marks | Title | Default Extension | Source Code | diff --git a/docs/src/docPages/api/nodes.md b/docs/src/docPages/api/nodes.md index f2b69335..524ac380 100644 --- a/docs/src/docPages/api/nodes.md +++ b/docs/src/docPages/api/nodes.md @@ -3,7 +3,7 @@ ## toc ## Introduction -Nodes add new capabilities to tiptap. Nodes are like block types, for example a paragraph, heading, or code block. +If you think of the document as a tree, then nodes are just a type of content in that tree. Examples of nodes are paragraphs, headings, or code blocks. But nodes don’t have to be blocks. They can also be rendered inline with the text, for example for **@mentions**. ## List of supported nodes | Title | Default Extension | Source Code | diff --git a/docs/src/docPages/examples/code-block-language.md b/docs/src/docPages/examples/syntax-highlighting.md similarity index 66% rename from docs/src/docPages/examples/code-block-language.md rename to docs/src/docPages/examples/syntax-highlighting.md index bdac1b35..03b9598a 100644 --- a/docs/src/docPages/examples/code-block-language.md +++ b/docs/src/docPages/examples/syntax-highlighting.md @@ -1,3 +1,3 @@ -# Code block language +# Syntax highlighting diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 33f95d42..27fe1fd2 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -37,7 +37,6 @@ # skip: true - title: Alpine.js link: /installation/alpine - type: new skip: true - title: Livewire link: /installation/livewire @@ -64,7 +63,6 @@ link: /examples/markdown-shortcuts - title: Menus link: /examples/menus - type: new - title: Tables link: /examples/tables # type: pro @@ -86,8 +84,8 @@ link: /examples/savvy - title: Interactivity link: /examples/interactivity - - title: Code block language - link: /examples/code-block-language + - title: Syntax highlighting + link: /examples/syntax-highlighting type: new - title: Guide @@ -96,7 +94,6 @@ link: /guide/configuration - title: Menus link: /guide/menus - type: new - title: Styling link: /guide/styling - title: Output @@ -112,14 +109,11 @@ link: /guide/extend-extensions - title: Interactive node views link: /guide/node-views - type: new items: - title: With JavaScript link: /guide/node-views/js - type: new - title: With React link: /guide/node-views/react - type: new - title: With Vue link: /guide/node-views/vue - title: A few examples