docs: update content

This commit is contained in:
Hans Pagel 2021-04-15 19:33:51 +02:00
parent 2185554226
commit f05e237346
5 changed files with 16 additions and 22 deletions

View File

@ -13,14 +13,14 @@ Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities]
## Vocabulary
ProseMirror has its own vocabulary and youll 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. |

View File

@ -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 |

View File

@ -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 dont 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 |

View File

@ -1,3 +1,3 @@
# Code block language
# Syntax highlighting
<demo name="Examples/CodeBlockLanguage" />

View File

@ -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