tiptap/docs/src/docPages/api/overview.md

14 lines
1019 B
Markdown
Raw Normal View History

# Overview
2020-10-28 23:49:44 +08:00
tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net).
2020-10-28 23:49:44 +08:00
### 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.
2020-09-26 04:22:44 +08:00
2020-10-28 23:49:44 +08:00
### 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.
2020-09-26 04:22:44 +08:00
2020-10-28 23:49:44 +08:00
### Extensions
Extensions add [nodes](/api/nodes), [marks](/api/marks) and/or [functionalities](/api/extensions) to the editor. A lot of those extensions bound their commands to common [keyboard shortcuts](/api/keyboard-shortcuts).
2020-10-28 23:49:44 +08:00
All those concepts are explained in detail on the following pages.