API Reference

One page per package, listing its public exports. Descriptions come from the TSDoc in the source; the guides explain how the features fit together.

Core engine

@stesura/core — the engine, one page per entry point (commands, constants, guards, helpers, keymap, omml, plugins, schema, stores, sub-editor, testing, types, utils)
@stesura/editor-react — mount hooks, StesuraEditor props, state, view, store and menu hooks, toolbar
@stesura/editor-react-ui — toolbar, button, color picker, dialog and field primitives for UI extensions
@stesura/fonts — the bundled editor font files
@stesura/icons — icon sets, provider and createIcon

Collaboration

@stesura/collab-adapter — collab plugins, presence, transport and errors; the /protocol entry
@stesura/collab-adapter-react — mount hooks, providers, presence and comment adapters
@stesura/collab-adapter-server — the server backend, Next and Node routes, /route-kit
@stesura/collab-adapter-local — the IndexedDB-backed local backend

Feature packs

@stesura/ai — autocomplete, text actions, chat tools
@stesura/ai-react — AI UI extension and chat components
@stesura/ai-server — chat, text-action and completion route handlers
@stesura/automation — hidden, repeating and field content, materializing and export
@stesura/automation-react — automation UI extension, field node view, toolbar
@stesura/bibliography — citations, sources, CSL formatting, BibTeX/RIS/CSL-JSON import, validation
@stesura/bibliography-react — bibliography UI extension, sources panel, citation picker
@stesura/docgen — assembling markdown sources and a template into a document
@stesura/docx — DOCX import and export, framework-free
@stesura/docx-react — DOCX toolbar buttons
@stesura/esign — signature fields and e-signature provider export
@stesura/esign-react — signature field UI extension
@stesura/contract-check — defined terms: engine, plugin and settings
@stesura/contract-check-react — defined-term hover card
@stesura/format-lint — format cleanup engine, plugin and commands
@stesura/format-lint-react — format cleanup panel, status bar and toolbar group
@stesura/markdown — markdown ↔ ProseMirror blocks
@stesura/mermaid — Mermaid diagram node, rendering, markdown and DOCX support, framework-free
@stesura/mermaid-react — diagram node view, source editor and toolbar
@stesura/pagination — page layout, line numbering, stores
@stesura/pagination-react — pagination UI extension, section node view, header/footer panel, diagnostics
@stesura/pdf-export-client — PDF export button and export-page shell
@stesura/pdf-export-server — headless-Chromium PDF renderer (Node)
@stesura/pdf-viewer-react — in-document PDF file previews (hand-written)
@stesura/proofread — proofread plugin, commands, API errors, caches
@stesura/proofread-react — proofread UI extension, panel and menus
@stesura/references — footnotes, endnotes and cross-references, framework-free
@stesura/references-react — footnote, endnote and cross-reference UI
@stesura/track-changes — tracking plugin, transaction modifier, diff and compare
@stesura/track-changes-react — track-changes UI extension, context menu, toolbar