Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (53 loc) · 2.18 KB

README.md

File metadata and controls

74 lines (53 loc) · 2.18 KB

Preview of Kirby Extended Writer plugin

Most features that this plugin provides or is meant to provide in the future will be added to Kirby 4.0+. It still works for Kirby 3.6-3.9+. Going forward, this plugin will be archived and not receive any more updates as our wishes have been fulfilled :)

Extended Writer

Extended Writer supercharges Kirby's built-in Writer field and block with useful marks, nodes and features you wish were built-in.

Features

  • New marks:
    • Highlight: Highlight text using the html <mark> tag
  • New nodes:
    • Larger Paragraph: A larger paragraph, e.g. for short introduction or highlighted passages. (<div class="-larger-paragraph">)
  • Enable & disable heading levels of the heading node with h1/h2/h3/h4/h5/h6
  • Node property support for the List field, to disable the default bullet list or ordered list nodes
  • Styling customizations via props (e.g. text-align)

Requirements

  • Kirby >= 3.6.0
  • php >= 7.4 / 8.0

Installation

Download

Download and copy this repository to /site/plugins/kirby-extended-writer.

Git Submodule

git submodule add https://github.com/coralic/kirby-extended-writer.git site/plugins/kirby-extended-writer

Composer

composer require coralic/kirby-extended-writer

Usage

This plugin adds the mark highlight and the nodes largerParagraph, h1, h2, h3, h4, h5 and h6. You can activate them in the writer field like this:

text:
  label: Text
  type: writer
  marks:
    - bold
    - italic
    - link
    - email
    - highlight
  nodes:
    - h1
    - h2
    - h3
    - largerParagraph
    - bulletList
    - orderedList

Credits

License

MIT License © 2021-2022 Tobias Möritz