2rats/yii2-markdown

Markdown Widget for Yii2

dev-master 2024-11-01 12:15 UTC

Requires

• yiisoft/yii2: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.0

MIT

• Igor Chepurnoy

• yii2
• yii2 markdown editor
• yii2 markdown widget

README

Markdown Widget for Yii 2

Widget based on SimpleMDE - Markdown Editor

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yii2mod/yii2-markdown "*"

or add

"yii2mod/yii2-markdown": "*"

to the require section of your composer.json.

Usage

Once the extension is installed, simply add widget to your page as follows:

1. Usage with ActiveForm and model

<?php echo $form->field($model, 'content')->widget(\yii2mod\markdown\MarkdownEditor::class, [
    'editorOptions' => [
        'showIcons' => ["code", "table"],
    ],
]); ?>

1. Usage without ActiveForm and model

<?php echo \yii2mod\markdown\MarkdownEditor::widget([
    'name' => 'markdown-editor',
    'editorOptions' => [
        'showIcons' => ["code", "table"],
    ],
]);
?>

Markdown Editor Options

You can find them on the options page