Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.52 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.52 KB

@shelamkoff/rector

Rector is an extensible browser-native block editor with atomic undo and redo, versioned JSON documents, inline formatting, block plugins, and document rendering. Editor demo

Documentation

The complete guides, API reference, extension contracts, plugin catalog, and live demo are published with VitePress:

Installation

npm install @shelamkoff/rector

See the getting started guide for setup, required styles, plugin registration, document persistence, and lifecycle management.

Styles

createEditor() and createEditorRenderer() use injectStyles: true by default. They load only the styles declared by the registered extensions and release their reference-counted <link> elements on full destruction.

Bundler-based applications can instead set injectStyles: false and import CSS explicitly. Use @shelamkoff/rector/styles.css for every built-in style, or combine styles/editor.css / styles/renderer.css with selected subpaths such as plugins/image/styles.css, inline-plugins/color/styles.css, and renderer/renderers/carousel/styles.css.

Project