uran1980/yii2-bootstrap-markdown-editor

Yii2 Markdown Editor based on Bootstrap Markdown.

Yii2 Bootstrap Markdown Editor

Yii2 Markdown Editor based on Bootstrap Markdown., _(*1)

This component use folowing libraries: * Marked -- a full-featured markdown parser and compiler, written in JavaScript. * To markdown -- an HTML to Markdown converter written in javascript. * Bootstrap Markdown -- JSimple Markdown editing tools that works!, _(*2)

Installation

Composer

The preferred way to install this extension is through Composer., _(*3)

Either run, _(*4)

php composer.phar require uran1980/yii2-bootstrap-markdown-editor "dev-master"

or add, _(*5)

"uran1980/yii2-bootstrap-markdown-editor": "dev-master"

to the require section of your composer.json, _(*6)

Usage

Active widget

In view in active form:, _(*7)

    
    field($model, 'content')->widget(MarkdownEditor::className(), [
        'clientOptions' => ['language' => Yii::$app->language],
        'options'       => ['data-provider' => 'markdown'],
    ]); ?>
    

Simple widget

In view:, _(*8)

<?php
use uran1980\yii\widgets\markdown\MarkdownEditor;

echo MarkdownEditor::widget([
    'name'          => 'md-editor',
    'value'         => '# test message',
    'clientOptions' => ['language' => Yii::$app->language],
    'options'       => ['data-provider' => 'markdown'],
]);

See also

• Markdown reminder
• Markdown cheatsheet
• GFM (Github Flawored Markdown)

Author

Ivan Yakovlev, e-mail: uran1980@gmail.com, _(*9)