robbieaverill/silverstripe-markdowntextareafield

Supercharged textarea with markdown preview for Silverstripe CMS

Markdown capable TextareaField for Silverstripe CMS

, _(*1)

Features

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

Screenshot

, _(*2)

Credits and Authors

• Original author - Priit Hansen (@priithansen)
• Maintainer - Robbie Averill (@robbieaverill)
• Silverstripe CMS - http://www.silverstripe.org/
• PHP Markdown - http://michelf.ca/projects/php-markdown/
• Rangy Text Inputs - http://code.google.com/p/rangy/
• Markdown syntax - http://daringfireball.net/projects/markdown/
• Icons - http://www.famfamfam.com/lab/icons/silk/

Requirements

• SilverStripe >= 3.1
• PHP Markdown

Installation

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

Instructions

You can use the MarkdownText data type for regular markdown or MarkdownTextExtra for added syntax features:, _(*3)

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/use markdown syntax in templates:, _(*4)

    $MarkdownContent    







    $MarkdownContent.MarkdownAsHTML    







    $MarkdownContent.MarkdownExtraAsHTML    







    
        // Render JSON content
        $MarkdownContent.MarkdownAsJS
        // or
        $MarkdownContent.MarkdownExtraAsJS
    

Notes

• Bug reports and ideas more than welcome.