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

docs: update content

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/docPages/api/concept.md
View File

@@ -14,13 +14,13 @@ Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities]
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. 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 | | Word | Description |
| ----------- | ------------------------------------------------------------------------ | | ----------- | --------------------------------------------------------------------------------- |
| Schema | Configures the structure your content can have. | | Schema | Configures the structure your content can have. |
| Document | The actual content in your editor. | | Document | The actual content in your editor. |
| State | Everything to describe the current content and selection of your editor. | | State | Everything to describe the current content and selection of your editor. |
| Transaction | A change to the state (updated selection, content, …) | | Transaction | A change to the state (updated selection, content, …) |
| Extension | Registeres new functionality. | | Extension | Registeres new functionality. |
| Node | Adds blocks, like heading, paragraph. | | Node | Nodes are a type of content, for example a heading or a paragraph. |
| Mark | Adds inline formatting, for example bold or italic. | | 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. | | Command | Execute an action inside the editor, that somehow changes the state. |
| Decoration | Styling on top of the document, for example to highlight mistakes. | | Decoration | Styling on top of the document, for example to highlight mistakes. |

2
docs/src/docPages/api/marks.md
View File

@@ -3,7 +3,7 @@
## toc ## toc
## Introduction ## 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 ## List of supported marks
| Title | Default Extension | Source Code | | Title | Default Extension | Source Code |

2
docs/src/docPages/api/nodes.md
View File

@@ -3,7 +3,7 @@
## toc ## toc
## Introduction ## 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 ## List of supported nodes
| Title | Default Extension | Source Code | | Title | Default Extension | Source Code |

2
docs/src/docPages/examples/code-block-language.md → docs/src/docPages/examples/syntax-highlighting.md
View File

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

10
docs/src/links.yaml
View File

@@ -37,7 +37,6 @@
# skip: true # skip: true
- title: Alpine.js - title: Alpine.js
link: /installation/alpine link: /installation/alpine
type: new
skip: true skip: true
- title: Livewire - title: Livewire
link: /installation/livewire link: /installation/livewire
@@ -64,7 +63,6 @@
link: /examples/markdown-shortcuts link: /examples/markdown-shortcuts
- title: Menus - title: Menus
link: /examples/menus link: /examples/menus
type: new
- title: Tables - title: Tables
link: /examples/tables link: /examples/tables
# type: pro # type: pro
@@ -86,8 +84,8 @@
link: /examples/savvy link: /examples/savvy
- title: Interactivity - title: Interactivity
link: /examples/interactivity link: /examples/interactivity
- title: Code block language - title: Syntax highlighting
link: /examples/code-block-language link: /examples/syntax-highlighting
type: new type: new
- title: Guide - title: Guide
@@ -96,7 +94,6 @@
link: /guide/configuration link: /guide/configuration
- title: Menus - title: Menus
link: /guide/menus link: /guide/menus
type: new
- title: Styling - title: Styling
link: /guide/styling link: /guide/styling
- title: Output - title: Output
@@ -112,14 +109,11 @@
link: /guide/extend-extensions link: /guide/extend-extensions
- title: Interactive node views - title: Interactive node views
link: /guide/node-views link: /guide/node-views
type: new
items: items:
- title: With JavaScript - title: With JavaScript
link: /guide/node-views/js link: /guide/node-views/js
type: new
- title: With React - title: With React
link: /guide/node-views/react link: /guide/node-views/react
type: new
- title: With Vue - title: With Vue
link: /guide/node-views/vue link: /guide/node-views/vue
- title: A few examples - title: A few examples