Home

Kirby Editor Docs

Kirby Editor is a new type of WYSIWYG editor for Kirby. It's a mixture between a regular WYSIWYG and a block editor to bring together the best parts of both worlds in a user-friendly interface.

Installation

Download

Download and copy this repository to /site/plugins/editor.

Git submodule

git submodule add https://github.com/bastianallgeier/editor.git site/plugins/editor

Usage

Blueprint setup

Once the plugin is installed, you can use the new editor field type in your blueprints:

fields:
  text:
    label: Editor
    type: editor

In your templates

The editor stores its content as JSON. To convert it to HTML you can use the blocks field method in your templates.

<?= $page->text()->blocks() ?>

Block types

Custom HTML output

Block extensions