[{"data":1,"prerenderedAt":299},["ShallowReactive",2],{"quirekit-doc:\u002Fen\u002Fdocs":3},{"id":4,"title":5,"body":6,"description":287,"extension":288,"keywords":289,"locale":290,"meta":291,"navigation":292,"order":293,"path":294,"section":295,"seo":296,"stem":297,"__hash__":298},"docs\u002Findex.en.md","Core documentation",{"type":7,"value":8,"toc":279},"minimark",[9,37,42,56,80,84,257,261,264,267,271],[10,11,12,13,17,18,22,23,22,26,22,29,32,33,36],"p",{},"QuireKit is a document editor framework ",[14,15,16],"strong",{},"extending Tiptap Core",". It retains familiar ",[19,20,21],"code",{},"Editor",", ",[19,24,25],{},"Extension",[19,27,28],{},"Node",[19,30,31],{},"Mark"," and command-chain APIs, maintains a consistent ProseMirror runtime under the ",[19,34,35],{},"@quirekit"," scope, and adds contracts for views, layout and document formats.",[38,39,41],"h2",{"id":40},"from-core-to-a-complete-product","From Core to a complete product",[10,43,44,45,50,51,55],{},"For a Classic-like document product, follow ",[46,47,49],"a",{"href":48},"\u002Fen\u002Fbuild","Build an editor product",": your first editor → document model → Canvas\u002FSVG 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 ",[46,52,54],{"href":53},"\u002Fen\u002Fbuild\u002Freference","project reference"," when you need the complete implementation.",[10,57,58,22,61,22,65,69,70,74,75,79],{},[46,59,21],{"href":60},"\u002Fen\u002Fapi\u002Feditor",[46,62,64],{"href":63},"\u002Fen\u002Fapi\u002Fextensions","extension contracts",[46,66,68],{"href":67},"\u002Fen\u002Fapi\u002Fview","View"," and ",[46,71,73],{"href":72},"\u002Fen\u002Fclassic\u002Fapi","product API"," explain arguments, results and effects by task; ",[46,76,78],{"href":77},"\u002Fen\u002Fapi\u002Fcore","Core signatures"," remain a supplementary reference.",[38,81,83],{"id":82},"choose-your-path","Choose your path",[85,86,87,100],"table",{},[88,89,90],"thead",{},[91,92,93,97],"tr",{},[94,95,96],"th",{},"Your task",[94,98,99],{},"Start here",[101,102,103,115,126,137,148,159,170,181,192,203,214,224,235,246],"tbody",{},[91,104,105,109],{},[106,107,108],"td",{},"Create an editor",[106,110,111],{},[46,112,114],{"href":113},"\u002Fen\u002Fguide\u002Fquick-start","Quick start",[91,116,117,120],{},[106,118,119],{},"Move from Tiptap",[106,121,122],{},[46,123,125],{"href":124},"\u002Fen\u002Fguide\u002Ftiptap","Tiptap relationship",[91,127,128,131],{},[106,129,130],{},"Understand data",[106,132,133],{},[46,134,136],{"href":135},"\u002Fen\u002Fconcepts\u002Fdocument","Documents and schemas",[91,138,139,142],{},[106,140,141],{},"Load server content or restore a backup",[106,143,144],{},[46,145,147],{"href":146},"\u002Fen\u002Fguide\u002Fcontent","Content operations and validation",[91,149,150,153],{},[106,151,152],{},"Read caret positions or select text\u002Fnodes",[106,154,155],{},[46,156,158],{"href":157},"\u002Fen\u002Fconcepts\u002Fselection","Selections and positions",[91,160,161,164],{},[106,162,163],{},"Build a capability",[106,165,166],{},[46,167,169],{"href":168},"\u002Fen\u002Fconcepts\u002Fextensions","Extension model",[91,171,172,175],{},[106,173,174],{},"Add options, commands and runtime state",[106,176,177],{},[46,178,180],{"href":179},"\u002Fen\u002Fguide\u002Fbehavior","Behavior extension tutorial",[91,182,183,186],{},[106,184,185],{},"Transform input or observe transaction state",[106,187,188],{},[46,189,191],{"href":190},"\u002Fen\u002Fguide\u002Frules","Input rules and PM plugins",[91,193,194,197],{},[106,195,196],{},"Add interactive node controls",[106,198,199],{},[46,200,202],{"href":201},"\u002Fen\u002Fguide\u002Fnode-view","NodeView tutorial",[91,204,205,208],{},[106,206,207],{},"Exchange content in browsers or servers",[106,209,210],{},[46,211,213],{"href":212},"\u002Fen\u002Fguide\u002Fformats","HTML and Markdown",[91,215,216,219],{},[106,217,218],{},"Look up a method",[106,220,221],{},[46,222,223],{"href":77},"Core API",[91,225,226,229],{},[106,227,228],{},"Look up creation settings and callbacks",[106,230,231],{},[46,232,234],{"href":233},"\u002Fen\u002Fapi\u002Foptions","Editor options and events",[91,236,237,240],{},[106,238,239],{},"Try an existing plugin",[106,241,242],{},[46,243,245],{"href":244},"\u002Fen\u002Fplugins","Plugin directory",[91,247,248,251],{},[106,249,250],{},"Embed a paginated product and choose free or commercial use",[106,252,253],{},[46,254,256],{"href":255},"\u002Fen\u002Fclassic","Classic documentation",[38,258,260],{"id":259},"framework-and-product","Framework and product",[10,262,263],{},"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.",[10,265,266],{},"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.",[38,268,270],{"id":269},"current-release","Current release",[10,272,273,274,278],{},"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 ",[46,275,277],{"href":276},"\u002Fen\u002Fsupport","support and licensing",".",{"title":280,"searchDepth":281,"depth":281,"links":282},"",2,[283,284,285,286],{"id":40,"depth":281,"text":41},{"id":82,"depth":281,"text":83},{"id":259,"depth":281,"text":260},{"id":269,"depth":281,"text":270},"Start with Core concepts and APIs, then build your own editor.","md",null,"en",{},true,0,"\u002Fen\u002Fdocs","Getting started",{"title":5,"description":287},"index.en","rZ4HDucZMhpvyES07gHtah7PiKLMoFbOTdR9ay-NOZ4",1793045207764]