axllent/silverstripe-gfmarkdown

GitHub Flavored Markdown editing & rendering using Parsedown

Installs: 2 553

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 2

Forks: 4

Open Issues: 0

Type:silverstripe-vendormodule

2.2.5 2018-02-27 03:53 UTC

This package is auto-updated.

Last update: 2020-07-27 13:54:13 UTC


README

This module adds a field and a data type that allows for Markdown editing in the CMS using the Github Flavoured Markdown parser Parsedown to render the html.

It includes the Ace editor for CMS editing.

Requirements

  • SilverStripe 4.x

Installation

composer require axllent/silverstripe-gfmarkdown

Usage

Use the Markdown data type as your fields data type, and the MarkdownEditor field in the CMS for editing.

Example:

<?php

use Axllent\Gfmarkdown\Forms\MarkdownEditor;

class MyPage extends Page
{
    public static $db = array(
        'MarkdownContent' => 'Markdown'
    );

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

        // If you want the Ace markdown editor in the CMS
        $fields->addFieldToTab('Root.Main',
            MarkdownEditor::create('MarkdownContent')
                ->setTheme('github')            // set theme
                ->setRows(20)                   // set number of rows in CMS
                ->setWrap(false)                // disable word wrapping
                ->setHighlightActiveLine(true)  // enable line highlighting
        );

        return $fields;
    }
}

SilverStripe Template:

<div class="content">
    $MarkdownContent  <!-- Will show as rendered html -->
</div>