README

基于 Bootstrap Markdown 的 Yii2 Markdown 编辑器。

此组件使用以下库

• Marked -- 用 JavaScript 编写的功能齐全的 markdown 解析器和编译器。
• To markdown -- 用 JavaScript 编写的 HTML 到 Markdown 转换器。
• Bootstrap Markdown -- 工作良好的 JSimple Markdown 编辑工具！

安装

Composer

安装此扩展的首选方式是通过 Composer。

运行以下命令之一

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

或添加以下内容到您的 composer.json 文件的 require 部分

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

使用方法

激活小部件

在活动表单中的视图

<?php

use yii\widgets\ActiveForm;
use efureev\markdown\MarkdownEditor;
?>

<div class="active-form">
    <?php $form = ActiveForm::begin(); ?>
    <?php echo $form->field($model, 'content')->widget(MarkdownEditor::className(), [
        'clientOptions' => [
            'language' => Yii::$app->language,
            'additionalButtons' => [
                'drink' => [
                    'cmdBeer' => [
                        'title' => 'Beer',
                        'toggle' => false,
                        'icon' => 'glyphicon glyphicon-glass',
                        'callback' => 'function(e){alert("sdasda");}'
                    ],
                    'cmdBeer2' => [
                        'title' => 'Beer2',
                        'toggle' => true,
                        'icon' => 'glyphicon glyphicon-glass',
                        'callback' => 'function(e){
                            // Replace selection with some drinks
                            var chunk, cursor,
                                selected = e.getSelection(), content = e.getContent(),
                                drinks = ["Heinekken", "Budweiser",
                                        "Iron City", "Amstel Light",
                                        "Red Stripe", "Smithwicks",
                                        "Westvleteren", "Sierra Nevada",
                                        "Guinness", "Corona", "Calsberg"],
                                index = Math.floor((Math.random()*10)+1)
            
            
                              // Give random drink
                              chunk = drinks[index]
                
                              // transform selection and set the cursor into chunked text
                              e.replaceSelection(chunk)
                              cursor = selected.start
                
                              // Set the cursor
                              e.setSelection(cursor,cursor+chunk.length)
                            }'
                        ]
                    ]
                ]
        ],
        'options'       => ['data-provider' => 'markdown'],
        
    ]); ?>
    <?php ActiveForm::end(); ?>
</div>

简单小部件

在视图

<?php
use efureev\markdown\MarkdownEditor;

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

更新日志

v0.0.6

• 添加 icons

v0.0.5

• 添加 additionalButtons

另请参阅

• Markdown 提示
• Markdown 快速参考
• GFM (Github Flawored Markdown)

作者

Ivan Yakovlev，电子邮件： uran1980@gmail.com Eugene Fureev，电子邮件： furegin@yandex.ru