在Laravel中集成markdown编辑器

创建于 10个月前 / 阅读数 236 / PHP


简介

对于后台管理的文本操作而言,一个优秀的编辑器会宁工作事半功倍,目前用的比较多的如百度编辑器等,而对于开发人员来说,一个支持 markdown 的文本编辑器更是锦上添花。

本文将介绍 Editor.md 作为后台的文章编辑器。
官方地址:Click me
案例截图:

在 Laravel 中使用

对于普通使用可以在官方地址按照文档获取资源,考虑到便携性与可复用性,我对编辑器进行了封包。

2018-11-28 09:53:48 星期三
新增上传图片对 upyun 的支持

安装

$ composer require wenslim/editormd

配置

$ php artisan vendor:publish --provider="Wenslim\editormd\EditorServiceProvider"

关于包更新

  1. 请查看 github 文档当前包最新版本号, 目前是 0.1.2
    composer.json
    "require": {
     ...
     "wenslim/editormd": "~0.1"
    },
    
    更新
    $ composer update wenslim/editormd
    
  2. 删除 config / editormd.php 配置文件并通过上面指令重新生成配置

默认配置

config / editormd.php

<?php

return [
    // textarea 容器的 id
    "id" => 'editor',
    // 编辑器宽高
    'width' => '100%',
    'height' => '500',
    // lib 类库地址
    'path' => '/vendor/editormd/lib/',
    // 顶部工具栏主题 白 - default | 黑 - dark
    'theme' => 'default',
    // 编辑区域主题 - 更多主题 vendor / editormd / lib / codemirror / theme 的 css 名称
    'editorTheme'=> 'default',
    // 显式区域主题 白 - default | 黑 - dark
    'previewTheme'=> 'default',
    // 编辑器初始化内容
    'markdown' => 'md',
    // 代码折叠
    'codeFold' => true,
    // 实时同步
    'syncScrolling' => true,
    // 保存 HTML 到 Textarea
    'saveHTMLToTextarea' => true,
    // 搜索替换
    'searchReplace' => true,
    // 开启 emoji 支持
    'emoji' => true,
    // 开启图片上传
    'imageUpload' => true,
    // 自定义存储目录
    'imageSavePath' => 'uploads/images/' . date('Ymd', time()),
    // 允许的图片大小 kb
    'imageSize' => '100',
    // Editormd.php 存储类型 default / upyun
    'saveType' => 'upyun',
    /**
     * upyun 设置
     * 
     * 如最终图片位置为 https://images.iiiku.com/test/test_xxxxxxx.png
     * 
     * 注意:请参考下面案例写法,path 不要有多余的 '/'
     */
    // upyun 保存图片的前缀,按照自己喜欢定义
    'savePrefix' => 'test_',
    // upyun 存储地址,如绑定 CNAME 后的二级域名,没有申请 SSL 请用 http://
    'savePath' => 'https://images.iiiku.com',
    // upyun 写入地址,相对 savePath的地址
    'writePath' => '/test/',
];

使用 default 时

.env

...
APP_URL=xxx

说明:如果是本地,请填写你的域名

使用 upyun 时

修改配置
config / services.php

return [
    ...
    'editormd' => [
        'upyun' => [
            'name' => env('UPYUN_NAME'),
            'user' => env('UPYUN_USER'),
            'password' => env('UPYUN_PASS'),
        ]
    ]
];

说明:

  • name - 服务名称
  • user - 操作员名称
  • pass - 操作员密码

.env

...
UPYUN_NAME=xxx
UPYUN_USER=xxx
UPYUN_PASS=xxx

发布时

resources / views / articles / create.blade.php

<head>
<!-- 引入资源样式 -->
{!! editormd_style() !!}
</head>
<body>
    <div id="editor">
        <textarea name="content"></textarea>
    </div>
    <script src="https://cdn.bootcss.com/jquery/2.2.3/jquery.js"></script>
    <!-- 引入资源脚本 -->
    {!! editormd_script() !!}
</body>

说明:

  1. 请在资源脚本之前引入 Jquery
  2. 请为 textarea 的父级元素指明 id 选择器

注意:若使用了 laravel mix 项目默认会生成 app.js,其中包含了 jQuery,此时只需要在脚本引入之前加载 app.js 即可,若未使用,可以采取上述引入 cdn 的方式

存储时

app / Http / Controllers / ArticlesController.php

use App\Models\Article;

public function store(ArticleRequest $request, Article $article)
{
    $article -> fill($request -> all());
    ...
    $article -> markdown = $request -> input('editor-html-code');
    $article -> save();
}

说明:

  1. 默认存储 content 的原始内容
  2. 新增 markdown 字段存储编译后的内容

显示时

resources / views / articles / show.blade.php

{!! $article -> markdown !!}

说明:用于修改时,请读取 content 的内容