Skip to content
/ editor Public
forked from getkirby/editor

A new type of WYSIWYG editor for Kirby

Notifications You must be signed in to change notification settings

PatricB/editor

 
 

Repository files navigation

Kirby Editor

Kirby Editor is a new visual writing and layout field for Kirby. Compose long-form text with consistent inline styles. Add images, videos, quotes and more. Bring your own block types and always rest assured that the output will be valid, customizable HTML.

Editor Screencast

Installation

Manual

Download and copy this repository to /site/plugins/editor of your Kirby installation.

Composer

composer require getkirby/editor

Features

Block types

Use the Editor's block types to create your content:

  • Code
  • Heading 1
  • Heading 2
  • Heading 3
  • Image
  • KirbyText
  • Line
  • Numbered List
  • Quote
  • Text
  • Unordered List
  • Video

You need more? Create your own block type extensions to integrate the Editor into your projects seamlessly.

Markdown shortcuts

Writing your articles and copy always feels natural in the Editor. Use markdown shortcuts such as #, -, **** and more to add new blocks without ever leaving your keyboard.

Drag & Drop sorting of blocks

Use the intuitive drag & drop interface to rearrange blocks.

Customizable HTML

The HTML of each block can be fine-tuned and customized. Create your own block snippets and use Kirby's familiar template engine to create the markup you are looking for.

HTML & Markdown import

Import HTML & Markdown or paste content directly into the Editor to create new blocks. The smart parser of the Editor will always give you clean structured data for even the worst HTML (We are looking at you, Word)

Documentation

https://github.com/getkirby/editor/wiki

Credits

Bastian Allgeier

License

Kirby and the Kirby Editor plugin are not free software. In order to run Kirby and the Editor plugin on a public server you must purchase a valid license. The Editor is free for all Kirby license owners.

About

A new type of WYSIWYG editor for Kirby

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 53.3%
  • Vue 37.6%
  • JavaScript 8.6%
  • Other 0.5%