lucinyan / blocky-editor

An headless editor built with blocks.

Blocky Editor

Blocky Editor is an editor which supports the concept of blocks. It can help you to build an editor like Notion. It's tiny, fast and extensible. You can extend it with blocks.

| Demo | Documentations |

Why?

The main goal of this project is to provide an editor which is small and fast enough to be embedded in Notion-like apps.

It doesn't depend on any heavy editor framework, and it handles the complex text-editing details for you.

The developers only need to develop their blocks with their favourite UI frameworks.

Features

• Extremely small.
• Extensible. Extend the editor with custom blocks and spans.
• Static typed.
• Collaborative editing.

Packages

• Data(): The data structure of the editor. Can be used without browser environment.
• Core(): The core of the editor. Written in vanilla JS. It can be used standalone without any UI frameworks.
  • Gzipped size: ~28kb
• Preact(): Wrap the editor in Preact. Provide the UI facilities such as toolbar and banner.
• Example: The example to demonstrate how to use the editor.

Resources

• Get started
• Contributing

Compatibility

Tested on

• Google Chrome
• Microsoft Edge
• Safari