Executable migration guide
Migrate from CKEditor 5 to RichTextEditor
Map common configuration and transfer real document content with the package adapter, while keeping unsupported features visible for review.
Install and run
import { migrateConfig, migrateEditor } from
"@richscripts/richtexteditor/migration";
const plan = migrateConfig("ckeditor5", legacyConfig);
const result = migrateEditor("ckeditor5", legacyEditor, rte);
console.table(result.warnings);Content handoff
editor.getData() is the source API. CKEditor HTML is transferred directly and normalized when RichTextEditor loads it.
Configuration result
migrateConfig() returns target config, mapped commands, unmapped items and warnings. Review the report before replacing production initialization.
Automated coverage
- Maps nested toolbar.items, language and common commands.
- Reads a live editor through getData().
- Removes the need for an application-specific content copy script.
Manual review remains
- Custom model elements and converters need explicit serializers.
- Cloud collaboration history, comments and suggestions are separate application data.
Acceptance checklist
- Run the adapter on repository fixtures and representative production documents.
- Review every warning and unmapped toolbar item.
- Compare saved HTML—not only rendered appearance.
- Rebuild custom commands, uploads, permissions and collaboration data explicitly.
- Test undo, paste, keyboard, mobile and assistive-technology workflows before cutover.