QuireKit is a family of document editing packages: a Tiptap-compatible editor core built on ProseMirror, the MSFE source-first Markdown editor framework, a streaming Markdown reader, diagram and formula editors, and a shared UI component library.
Status: alpha. Packages are published as
0.xpre-releases. APIs may change between versions until 1.0.
| Area | Packages |
|---|---|
| Editor core | @quirekit/core, @quirekit/starter-kit, @quirekit/extension-*, @quirekit/pm-* |
| Markdown source editor (MSFE) | @quirekit/msfe-core, @quirekit/msfe-vue, @quirekit/msfe-react, @quirekit/msfe-starter-kit, @quirekit/msfe-* |
| Streaming Markdown reader | @quirekit/incremark-core, @quirekit/incremark, @quirekit/incremark-react |
| Diagrams | @quirekit/flowchart, @quirekit/flowchart-x6, @quirekit/mind-map, @quirekit/mind-map-simple, @quirekit/whiteboard, @quirekit/whiteboard-excalidraw, @quirekit/text-diagram, @quirekit/chart |
| Formulas | @quirekit/math, @quirekit/math-ui, @quirekit/math-omml, @quirekit/math-mathjax |
| UI | @quirekit/ui, @quirekit/unocss-preset |
| Code editing | @quirekit/cm-*, @quirekit/lezer-markdown |
Packages whose README marks them as internal are dependencies of the packages above and carry no API guarantee.
Every package in this repository is MIT and free for any project, including the editor
core, the Canvas/SVG layout engine and views, the Classic and Block editor shells, MSFE,
MD Editor, the diagram and formula editors, data views and UI. Each package's LICENSE.md
is authoritative. Word compatibility (the Word semantic stack, DOCX round trips, PDF/OFD
export, review and official-document templates) ships separately as QuireKit commercial
components.
Vendored ProseMirror, CodeMirror and Lezer packages keep their upstream license files, and
third-party notices ship with every package in THIRD_PARTY_NOTICES.md.
QuireKit also offers separately licensed components (DOCX import and export, Word document features, PDF and OFD export, the AI runtime and assistants, and more). They are not part of this repository.
Requires Node 22 and pnpm 10.
pnpm install
pnpm build
pnpm testSee CONTRIBUTING.md. All contributions require accepting the CLA.