robbieaverill/silverstripe-markdowntextareafield

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

Supercharged textarea with markdown preview for Silverstripe CMS

2.0.0-beta.2 2016-08-11 03:33 UTC

Requires

• michelf/php-markdown: *
• silverstripe/cms: >=3.1.x-dev,<4.0
• silverstripe/framework: >=3.1.x-dev,<4.0

Replaces

• priithansen/silverstripe-markdowntextareafield: *

BSD-3-Clause

• Priit Hansen
• Robbie Averill

• module
• cms
• markdown
• silverstripe

README

Features

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

Screenshot

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:

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:

<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>

<div class="content">
    <pre>
        // Render JSON content
        $MarkdownContent.MarkdownAsJS
        // or
        $MarkdownContent.MarkdownExtraAsJS
    </pre>
</div>

Notes

• Bug reports and ideas more than welcome.