rkeet/zf-form-markdown

This package is abandoned and no longer maintained. No replacement package was suggested.

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

Maintainers

Details

github.com/rkeet/zf-form-markdown

Homepage

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

pkg:composer/rkeet/zf-form-markdown

0.1.4 2020-03-22 10:01 UTC

Requires

MIT f962770653d75a8678dbc8cc09bab6bca1a6d70b

formmodulemarkdownelementparsedownzf3Zend Framework 3

This package is auto-updated.

Last update: 2020-03-22 10:01:50 UTC

README

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