Skip to content

API Inventory

Use this page as a quick lookup for package entry points, primary exports, and related docs.

@sciflow/editor-start

@sciflow/editor-core

Export Description
Editor Factory for creating/mounting the editor runtime.
SyncStrategy Interface for persistence/collaboration.
CommandRunner Immediate + flow command API (accessible via editor.getCommands()).
runInsertCitation, runInsertFigure, list/blockquote/copy-paste helpers, etc. Helper functions exposed by individual features.

Relevant docs:

@sciflow/schema-prosemirror

  • manuscriptSchema – the full schema used by the editor.
  • nodeFromJSON, marksFromJSON – utilities for instantiating nodes from stored snapshots.

Feature Modules

Features live under packages/editor/core/src/lib/features/*. Each folder typically exports:

  • Command helpers (runInsertFigure, runInsertCitation).
  • Types (InsertFigureOptions, etc.).
  • Node views when UI rendering is required.
  • Ready-made feature registrations (figureFeature, listFeature, blockquoteFeature, ...).

Import them directly from the package:

import { runInsertFigure } from '@sciflow/editor-core/features/figure';

Tree shaking

Feature modules are safe to import individually. They only register themselves when you call registerCommands, so bundlers can drop unused code paths.