Skip to main content

​
Migrating from ProseMirror

SuperDoc is built on ProseMirror but provides a complete document editing solution rather than a framework.

​
Key differences

ProseMirrorSuperDoc
Framework requiring extensive setupReady-to-use DOCX editor
Manual schema definitionPre-built Word-compatible schema
DIY file format supportNative DOCX import/export
Custom plugin systemModule-based features

​
What changes

// ProseMirror
import { EditorState } from 'prosemirror-state';
import { EditorView } from 'prosemirror-view';
import { Schema } from 'prosemirror-model';
// ... 100+ lines of setup

// SuperDoc
import { SuperDoc } from '@harbour-enterprises/superdoc';
const superdoc = new SuperDoc({
  selector: '#editor',
  document: 'document.docx'
});

​
Accessing ProseMirror internals

While SuperDoc doesn’t support custom ProseMirror plugins, you can access the underlying instances: 
superdoc.on('editorCreate', ({ editor }) => {
  const view = editor.view;     // ProseMirror EditorView
  const state = view.state;     // ProseMirror EditorState
  const schema = state.schema;  // ProseMirror Schema
});

​
Limitations

  • No custom plugins: SuperDoc modules aren’t ProseMirror plugins
  • Fixed schema: Can’t modify the document schema
  • Controlled commands: Use SuperDoc’s command set, not raw transactions

​
Custom functionality

If you need features SuperDoc doesn’t provide, you have limited options:
  • Use SuperEditor for lower-level access
  • Request features via GitHub issues
  • Consider if SuperDoc is the right fit

​
Need help?

⌘I