Core documentation
Start with Core concepts and APIs, then build your own editor.
QuireKit is a document editor framework extending Tiptap Core. It retains familiar Editor, Extension, Node, Mark and command-chain APIs, maintains a consistent ProseMirror runtime under the @quirekit scope, and adds contracts for views, layout and document formats.
From Core to a complete product
For a Classic-like document product, follow Build an editor product: your first editor → document model → Canvas/SVG display → commands and interface → content extensions → product plugins → saving and files. Each chapter explains the task, demonstrates a focused change and gives you a result to try. Consult the project reference when you need the complete implementation.
Editor, extension contracts, View and product API explain arguments, results and effects by task; Core signatures remain a supplementary reference.
Choose your path
| Your task | Start here |
|---|---|
| Create an editor | Quick start |
| Move from Tiptap | Tiptap relationship |
| Understand data | Documents and schemas |
| Load server content or restore a backup | Content operations and validation |
| Read caret positions or select text/nodes | Selections and positions |
| Build a capability | Extension model |
| Add options, commands and runtime state | Behavior extension tutorial |
| Transform input or observe transaction state | Input rules and PM plugins |
| Add interactive node controls | NodeView tutorial |
| Exchange content in browsers or servers | HTML and Markdown |
| Look up a method | Core API |
| Look up creation settings and callbacks | Editor options and events |
| Try an existing plugin | Plugin directory |
| Embed a paginated product and choose free or commercial use | Classic documentation |
Framework and product
Core owns documents, transactions, commands and extension lifetimes. Views own presentation and input. Plugins contribute content and behavior. Classic composes these into a paginated product workspace. Core does not require Classic or the Word packages.
This sidebar covers Core concepts, APIs and the product-building tutorial. Plugins opens its integration and effects catalog; Classic opens separate product documentation for setup, configuration and licensing.
Current release
This is an Alpha with an evolving API. Core and common extensions use MIT; view, product and Word packages have separate licenses and distribution channels. See support and licensing.