# MSFE developer documentation

A Markdown source-first editor. The public API is currently experimental.

[简体中文](/llms.txt)

- [MSFE developer documentation](/raw/en/index.md): Build your Markdown editing experience with clear boundaries between source, interaction, and UI.
- [Quick start](/raw/en/guide/quick-start.md): Create your first editor through public package exports, then edit, read, and clean up.
- [Features and installation](/raw/en/features/catalog.md): Choose built-in packages, optional syntax, editing commands and host responsibilities.
- [Vue integration](/raw/en/guide/vue.md): Mount the editor within your existing component tree, preserving themes, injection, and view lifecycles.
- [React integration](/raw/en/guide/react.md): Mount the editor and portals through the React adapter while preserving application context.
- [Mounting and cleanup](/raw/en/guide/lifecycle.md): Let your application own containers and storage while the editor owns input, selections, and runtime resources.
- [Modes and read-only access](/raw/en/guide/modes.md): Switch between source and reading presentations in one instance, preserving content and history.
- [Reading and saving](/raw/en/guide/saving.md): Read Markdown on demand and connect storage or external updates through incremental events.
- [Commands and atomic transactions](/raw/en/guide/commands.md): Call, compose, query and author commands with failure and history semantics.
- [MD Editor component](/raw/en/guide/md-editor.md): Integrate a Markdown document editor that shares QuireKit Prose styles.
- [Incremark streaming Markdown](/raw/en/guide/incremark.md): Parse streamed text with optimized Lezer, replace components, extend syntax and nodes, and explicitly enable safe HTML.
- [Events and transaction state](/raw/en/guide/state.md): Subscribe to the right changes and distinguish source, state slots and temporary storage.
- [Selection and captured intent](/raw/en/guide/selection.md): Use logical source coordinates and prevent asynchronous actions from writing to stale ranges.
- [Diagnostics and verification](/raw/en/guide/debugging.md): Diagnose source fallback, rejected commands, resource leaks and interaction regressions.
- [Optional source collaboration](/raw/en/guide/collaboration.md): Add shared editing, remote cursors, and a collaborator list when you need them.
- [Export custom nodes to Word, PDF and OFD](/raw/en/guide/export-nodes.md): Share native content conversion and image rendering, with templates, resource failures, cancellation and Word metadata recovery.
- [Source first](/raw/en/concepts/source-first.md): Understand the relationship between Markdown, derived fields, component views, and transactions.
- [Extension model and composition](/raw/en/concepts/extensions.md): Understand create, configure, extend, installation order and ownership.
- [Custom nodes](/raw/en/extensions/custom-node.md): Follow a clickable status token through syntax, fields, commands, and component integration.
- [Containers and nested blocks](/raw/en/extensions/containers.md): Register business containers, style native content and provide disclosure controls.
- [Custom code blocks](/raw/en/extensions/code-blocks.md): Customize toolbars, language loading and styles while retaining native code editing.
- [Diagrams and fenced previews](/raw/en/extensions/diagrams.md): Build Mermaid and ECharts previews with loading, source fallback and resource cleanup.
- [Markdown plugins](/raw/en/extensions/markdown-plugins.md): Connect new syntax to incremental parsing, semantic queries and source presentation.
- [Input and paste rules](/raw/en/extensions/input-rules.md): Transform new input explicitly while preserving composition, bounded work and undo.
- [Projection layers and component lifetime](/raw/en/extensions/projections.md): Implement inline decoration, multiline previews, declared dependencies and measurement.
- [Asynchronous resources and cleanup](/raw/en/extensions/resources.md): Own loading, cancellation, retries and source intent across changing lifetimes.
- [UI and themes](/raw/en/customization/theme.md): Connect your design system while keeping source, commands, and components within their own boundaries.
- [Toolbars and dialogs](/raw/en/customization/toolbars.md): Build design-system controls with command availability, selection and asynchronous forms.
- [Custom search panels](/raw/en/customization/search.md): Replace search UI while retaining canonical queries, selection and replacement.
- [Images and external resources](/raw/en/customization/images.md): Resolve private assets, release resources and preserve durable source identifiers.
- [Editor API](/raw/en/api/editor.md): Look up the current public creation options, instance methods, and incremental events.
- [Source and component API](/raw/en/api/source.md): Look up syntax readers, field updates, and the guarded actions available to components.
- [Extension API](/raw/en/api/extensions.md): Authoring hooks, presets, rules and container control contracts.
- [Command and target API](/raw/en/api/commands.md): Command drafts, rejection results, external edits and captured ranges.
- [State and resource API](/raw/en/api/state.md): Typed definitions, effects, subscriptions and resource leases.
- [Rendering and host API](/raw/en/api/rendering.md): Projection layers, component mounting, languages, search and preview controls.
- [Support boundaries](/raw/en/support.md): Understand current capabilities and limitations before choosing syntax, frameworks, and interactions.