ornj/markdown-bundle

Form fields for inputting and previewing markdown in Symfony2

dev-master 2016-03-21 17:46 UTC

Requires

• php: >=5.3.0
• symfony/symfony: >=2.2

Suggests

• knplabs/knp-markdown-bundle: 1.2.*@dev

MIT

• Stephen Hurwitz
• James Rickard

• form
• bootstrap
• bootstrap form
• markdown

README

This bundle create a markdown form field allowing for the realtime previewing of markdown markup. It is intended to be used in a user interface built using Twitter Bootstrap. This bundle pairs nicely with SonataAdminBundle or MopaBootstrapBundle.

You should use KnpMarkdownBundle to render the markdown on your front end.

Markdown fields are rendered with controls and a preview using:

• Markdown JS
• To Markdown
• Bootstrap Markdown
• Bootbox.js

Installation

Install this bundle in your Symfony2 project by adding it to your composer.json.

{
    "require": {
        "ornj/markdown-bundle": "dev-master"
    }
}

After running updating composer, register the bundle in app/AppKernel.php.

$bundles = array(
   // ...
   new Ornj\Bundle\MarkdownBundle\OrnjMarkdownBundle(),
);

Usage

Enable Twig Template

This bundle provides a Twig template for rendering the markdown field. To use it there are two options.

Enable globally by adding the template to config.yml

twig:
    form:
        resources:
            - 'OrnjMarkdownBundle:Form:fields.html.twig'

or

Add the template in your form's twig template.

{% form_theme form 'OrnjMarkdownBundle:Form:fields.html.twig' %}

Add Styles and Javascript

Extend or modify your base admin template and add the following styles. Either SCSS or CSS can be used.

SCSS

{% stylesheets filter="cssrewrite, compass"
    '@OrnjMarkdownBundle/Resources/public/scss/*'
%}
<link rel="stylesheet" href="{{ asset_url }}" type="text/css" media="all" />
{% endstylesheets %}

CSS

{% stylesheets filter="cssrewrite, compass"
    '@OrnjMarkdownBundle/Resources/public/css/*'
%}
<link rel="stylesheet" href="{{ asset_url }}" type="text/css" media="all" />
{% endstylesheets %}

Javascript

Extend or modify your base admin template and add the following Javascript.

{% javascripts
    '@OrnjMarkdownBundle/Resources/public/js/markdown.js'
    '@OrnjMarkdownBundle/Resources/public/js/to-markdown.js'
    '@OrnjMarkdownBundle/Resources/public/js/bootbox.js'
    '@OrnjMarkdownBundle/Resources/public/js/bootstrap-markdown.js'
%}
<script type="text/javascript" src="{{ asset_url }}"></script>
{% endjavascripts %}

The Form Field

The markdown field is an extension of textarea. It can be used to render an input for any field expecting a string.

$builder->add('body', 'markdown');

Rendering in front end

You will need a parser in order to render the markdown as HTML. KnpMarkdownBundle adds a handy Twig extension for rendering the result.

To Do

1. Allow inclusion of textarea options.
2. Investigate removing physical copies of dependencies in bundle.
3. Allow customization of ui options through config.