rkeet/zf-form-markdown

Provides Form Element 'Markdown', to be used within Zend Framework 3 with Zend Form.


Keywords
form, module, markdown, element, parsedown, zf3, Zend Framework 3, markdown-converter, markdown-editor, markdown-to-html, zend-form, zend-framework, zend-framework3
License
MIT

Documentation

ZF Form Element Markdown

Provides the ability to use markdown as a type of input element.

Setup

Require module

To install the latest release, using Composer, run:

composer require rkeet/zf-form-markdown

Enable modules

To enable this module, enable both this module and AssetManager. In modules.config.php add the following:

'AssetManager',
'Keet\Markdown',

Usage in Form / Fieldset

Element provides an HTML <textarea> element and paired <div> element to render a preview of whatever is entered in text area.

use Keet\Markdown\Form\Element\Markdown;

...

$this->add(
    [
        'name'       => 'body',
        'type'       => Markdown::class,
        'options'    => [
            'label' => 'Body',
        ],
        'attributes' => [
            'rows'  => 4,
        ],
    ]
);

Module requirements:

Features

  • Provides Service (MarkdownService) for handling markdown conversion server-side
  • Provides a ZF Form Element (Markdown) for Form input
    • Provides Showdown to client when using Markdown Form Element

TODO's

  • Create better preview - possibly:
    • option: inject some overridable default styling
    • option: side-by-side preview instead of above/below
    • option: minimum (overridable) styling to always have a visible preview container
  • Figure out incompatibilities between Parsedown and ShowdownJS