priithansen/silverstripe-markdowntextareafield

Supercharged textarea with markdown preview for Silverstripe CMS

0.9.2 2013-08-02 01:50 UTC

README

Features

  • Live preview
  • Extendable toolbar with common markdown functions
  • Support for both regular markdown and extra functions

Screenshot

Alt text

Credits and Authors

Requirements

  • SilverStripe >=3.1
  • PHP Markdown

Installation

  • Use composer to install composer require priithansen/silverstripe-markdowntextareafield:*
  • Run /dev/build?flush=1

Instructions

You can use MarkdownText data type for regular markdown or MarkdownTextExtra for added syntax features.

class Page extends SiteTree {

    private static $db = array(
        'MarkdownContent' => 'MarkdownTextExtra',
    );

    public function getCMSFields() {
        $fields=parent::getCMSFields();

        $markdownfield = MarkdownTextareaField::create('MarkdownContent');
        $markdownfield->enableExtra(); // Enables extra syntax support for fields live preview.

        $fields->addFieldToTab('Root.Main', $markdownfield);        
        return $fields;
    }
}

Template:

It is also possible to override markdown syntax in template

<div class="content">
    $MarkdownContent    <!-- Depending on data type used -->
</div>

<div class="content">
    $MarkdownContent.MarkdownAsHTML    <!-- Works with both data types, regular markdown -->
</div>

<div class="content">
    $MarkdownContent.MarkdownExtraAsHTML    <!-- Works with both data types, extended syntax -->
</div>

Notes

  • Bug reports and ideas more than welcome