README

A Symfony bundle that provides a Markdown form field with live preview, powered by Symfony UX Live Components. Works both in EasyAdmin and in standard Symfony forms.

Requirements

PHP 8.2+
Symfony 7.0+ or 8.0+
Symfony UX Live Components 2.0+
EasyAdmin 4.0+ or 5.0+ (only if you want to use the EasyAdmin field)

Installation

composer require jackfumanchu/markdown-live-bundle

Then add the stimulus-textarea-autogrow package to your importmap:

php bin/console importmap:require stimulus-textarea-autogrow

The bundle throws a clear error at cache warmup if this package is missing.

Usage

In EasyAdmin

Use MarkdownField in your CRUD controllers:

use JackFuManchu\MarkdownLiveBundle\Field\MarkdownField;

public function configureFields(string $pageName): iterable
{
    yield MarkdownField::new('content');
}

In standard Symfony forms

Add the form theme to your Twig configuration:

# config/packages/twig.yaml
twig:
    form_themes:
        - '@JackFuManchuMarkdownLive/form/markdown_live_theme.html.twig'

Or apply it per-template:

{% form_theme form '@JackFuManchuMarkdownLive/form/markdown_live_theme.html.twig' %}

Use MarkdownType in your form classes:

use JackFuManchu\MarkdownLiveBundle\Form\Type\MarkdownType;

$builder->add('content', MarkdownType::class);

Options

MarkdownType supports the following options:

Option	Type	Default	Description
`preview`	`bool`	`true`	Show the live Markdown preview panel
`debounce`	`int`	`300`	Debounce delay in milliseconds

License

MIT

jackfumanchu / markdown-live-bundle

Maintainers

Package info

Statistics

Security