美文网首页MarkdownVue.js开发技巧前端Vue专辑
一款强大的Vue-markdown编辑器插件

一款强大的Vue-markdown编辑器插件

作者: hinesboy | 来源:发表于2017-04-20 13:19 被阅读15380次

    mavonEditor

    github项目地址
    演示网址

    基于Vue的markdown编辑器

    example (图片展示)

    PC PC-GIF

    查看更多图片点击这里...

    Use Setup (开始)

    Install mavon-editor (安装)

    $ npm install mavon-editor --save
    

    Use (如何引入)

    index.js:

        // 全局注册
        // import with ES6
        import Vue from 'vue'
        import mavonEditor from 'mavon-editor'
        // markdown-it对象:md.s_markdown, md => mavonEditor实例
        //                 or
        //                 mavonEditor.markdownIt 
        import 'mavon-editor/dist/css/index.css'
        // use
        Vue.use(mavonEditor)
        new Vue({
            'el': '#main',
            data() {
                return { value: '' }
            }
        })
    

    index.html

    <div id="main">
        <mavon-editor v-model="value"/>
    </div>
    

    更多引入方式点击这里...

    代码高亮

    如不需要hightlight代码高亮显示,你应该设置ishljs为false

    开启代码高亮props

        // ishljs默认为true
        <mavon-editor :ishljs = "true"></mavon-editor>
    

    为优化插件体积,从v2.4.2起以下文件将默认使用cdnjs外链:

    • highlight.js
    • github-markdown-css
    • katex(v2.4.7)

    代码高亮highlight.js中的语言解析文件和代码高亮样式将在使用时按需加载.
    github-markdown-csskatex仅会在mounted时加载

    Notice:
    可选配色方案支持的语言 是从 highlight.js/9.12.0 导出的

    不使用cdn,本地按需加载点击这里...

    图片上传

    <template>
        <mavon-editor ref=md @imgAdd="$imgAdd" @imgDel="$imgDel"></mavon-editor>
    </template>
    exports default {
        methods: {
            // 绑定@imgAdd event
            $imgAdd(pos, $file){
                // 第一步.将图片上传到服务器.
               var formdata = new FormData();
               formdata.append('image', $file);
               axios({
                   url: 'server url',
                   method: 'post',
                   data: formdata,
                   headers: { 'Content-Type': 'multipart/form-data' },
               }).then((url) => {
                   // 第二步.将返回的url替换到文本原位置![...](./0) -> ![...](url)
                   /**
                   * $vm 指为mavonEditor实例,可以通过如下两种方式获取
                   * 1. 通过引入对象获取: `import {mavonEditor} from ...` 等方式引入后,`$vm`为`mavonEditor`
                   * 2. 通过$refs获取: html声明ref : `<mavon-editor ref=md ></mavon-editor>,`$vm`为 `this.$refs.md`
                   */
                   $vm.$img2Url(pos, url);
               })
            }
        }
    }
    

    图片上传详情点击这里...

    • 默认大小样式为 min-height: 300px , min-width: 300px 可自行覆盖
    • 基础z-index: 1500
    • 仅用作展示可以设置props: toolbarsFlag: false , subfield: false, default_open: "preview"

    API 文档

    props

    name 名称 type 类型 default 默认值 describe 描述
    value String 初始值
    language String cn 语言选择,暂支持 cn: 中文简体 , en: 英文 , fr: 法语
    scrollStyle Boolean true 开启滚动条样式(暂时仅支持chrome)
    subfield Boolean true true: 双栏(编辑预览同屏), false: 单栏(编辑预览分屏)
    default_open String edit: 默认展示编辑区域 , preview: 默认展示预览区域 , 其他 = edit
    placeholder String 开始编辑... 输入框为空时默认提示文本
    editable Boolean true 是否允许编辑
    code_style String code-github markdown样式: 默认github, 可选配色方案
    toolbarsFlag Boolean true 工具栏是否显示
    toolbars Object 如下例 工具栏
    ishljs Boolean true 代码高亮(cdn外链)
     /*
        默认工具栏按钮全部开启, 传入自定义对象
        例如: {
             bold: true, // 粗体
             italic: true,// 斜体
             header: true,// 标题
        }
        此时, 仅仅显示此三个功能键
     */
    toolbars: {
          bold: true, // 粗体
          italic: true, // 斜体
          header: true, // 标题
          underline: true, // 下划线
          strikethrough: true, // 中划线
          mark: true, // 标记
          superscript: true, // 上角标
          subscript: true, // 下角标
          quote: true, // 引用
          ol: true, // 有序列表
          ul: true, // 无序列表
          link: true, // 链接
          imagelink: true, // 图片链接
          code: true, // code
          table: true, // 表格
          fullscreen: true, // 全屏编辑
          readmodel: true, // 沉浸式阅读
          htmlcode: true, // 展示html源码
          help: true, // 帮助
          /* 1.3.5 */
          undo: true, // 上一步
          redo: true, // 下一步
          trash: true, // 清空
          save: true, // 保存(触发events中的save事件)
          /* 1.4.2 */
          navigation: true, // 导航目录
          /* 2.1.8 */
          alignleft: true, // 左对齐
          aligncenter: true, // 居中
          alignright: true, // 右对齐
          /* 2.2.1 */
          subfield: true, // 单双栏模式
          preview: true, // 预览
      }
    

    events

    name 方法名 params 参数 describe 描述
    change String: value , String: render 编辑区发生变化的回调事件(render: value 经过markdown解析后的结果)
    save String: value , String: render ctrl + s 的回调事件(保存按键,同样触发该回调)
    fullscreen Boolean: status , String: value 切换全屏编辑的回调事件(boolean: 全屏开启状态)
    readmodel Boolean: status , String: value 切换沉浸式阅读的回调事件(boolean: 阅读开启状态)
    htmlcode Boolean: status , String: value 查看html源码的回调事件(boolean: 源码开启状态)
    subfieldtoggle Boolean: status , String: value 切换单双栏编辑的回调事件(boolean: 双栏开启状态)
    previewtoggle Boolean: status , String: value 切换预览编辑的回调事件(boolean: 预览开启状态)
    helptoggle Boolean: status , String: value 查看帮助的回调事件(boolean: 帮助开启状态)
    navigationtoggle Boolean: status , String: value 切换导航目录的回调事件(boolean: 导航开启状态)
    imgAdd String: filename, File: imgfile 图片文件添加回调事件(filename: 写在md中的文件名, File: File Object)
    imgDel String: filename 图片文件删除回调事件(filename: 写在md中的文件名)

    Dependencies (依赖)

    update(更新内容)

    Collaborators(合作者)

    Licence (证书)

    mavonEditor is open source and released under the MIT Licence.

    Copyright (c) 2017 hinesboy

    相关文章

      网友评论

      • 92a942c830a6:你好,我想问一下
        分梵蒂冈地方++Ohio++ 这个格式怎么转换成html啊
      • 菜鸡前端:正好有需求 mark
      • samfung09:你好,请问图片上传成功图片地址也成了真实路径,这时删除图片事件怎么写啊,直接删除md码就不说了,还有,为什么我在本地vue项目中点击上传图片要等一段时间才弹出文件选择框啊?挺急的,望解答,感谢
      • jochen2016:请问保存到数据库的html,读取的时候可以转换成md文本么?找了半天没找到办法~
        4e7cd6bc40d6:遇到了同样的问题,大佬能不能指点一下怎么保存md文本然后转换成html(我用的数据库是mongodb) 已经晕了:sob: :sob:
        jochen2016:@hinesboy ok,已经选择保存文本了,双引号做了replace,不知道会不会还有其他存储数据库的问题
        hinesboy:可以直接保存md文本
      • dandelion1000:你好,请问,我的项目中引入了这个插件,但是项目中自有的样式会覆盖markdown的样式该怎么解决呢
        节奏感cc:@hinesboy 也是样式问题,现在是vue-markdown里面的cdn样式覆盖了我对github-markdown样式的重写,我自定义的github-markdown是单独拷贝出来改写。这时候组件cdn的样式成为全局样式覆盖自定义样式,怎么解决好点,是要把外部的cdn样式导出到本地引用吗,求指点
        hinesboy:给外部样式添加scoped 避免样式穿透应该OK
      • mler801:大佬,为什么这个插件引入后,代码标识、表格标识都出不来效果啊?
        dandelion1000:可能项目中的样式覆盖了markdown的样式
      • 浅浅浅丿忧伤:mavonEditor 转换的html中的代码到前端未换行,能指点一下吗,http://weblog.tianhui.xin/liveLearn/5.html 不胜感激
      • 廖马儿:请问下,为何这里:`@imgAdd="$imgAdd"` 不设置为`@imgAdd="imgAdd"`? 方法直接使用`imgAdd`?
      • e52afe973928:请问,用着编辑的文章如何上传,我上传了content 里面的内容,没有格式
        turbohu:@hinesboy 你好,保存得时候怎么获取md源码和html文件,还有markdown解析器解析使用得是那个插件,前端小白一个,希望大神指点指点
        hinesboy:v-model可以双向绑定md的文本,@change @save事件也可以获取md源码可html文本,建议保存的是md源码,使用的时候直接通过markdown解析器解析 或者再次通过mavon展示
        noyanse:你好,请问解决了吗,我也遇到这个问题了
      • 8ede20054f59:你好,想问下怎么改变字体颜色呢,,能否加个字体颜色按钮呢
      • 43f281b5f655:> 屏幕分辨率低于768px ,自动取消【单栏 | 双栏】编辑模式 ,更改为【编辑 | 预览】切换 , 并且取消【沉浸式阅读】模式( > 768px 的眼睛图标为【阅读模式】 , 反之为【编辑 |预览】)

        这个想恢复,怎么操作呢
        hinesboy:可以到github https://github.com/hinesboy/mavonEditor 上参考最新文档,已经迭代很多版本,目前为2.4.14版本
      • cd71c3b5a6d9:可以一个页面多个编辑器吗
        hinesboy:是可以的
      • 牛鱼鹿:有个疑惑希望作者帮忙解,我想用这个编辑器做文档编辑,但是希望网页展现的时候能够对应成html,希望大牛给点建议
        早安_5b44:@change 可以传两参数, value 是md,render是html,刚开始我只传了val,后来仔细看了文档,发现还有个render
        hinesboy:插件提供获取对应html的方法,详见https://github.com/hinesboy/mavonEditor
      • 杨肆月:这个项目下载之后怎么在本地运行出来?
        hinesboy:这是一个基于vue的js插件,直接通过npm引入即可使用
      • 02138a8b61bd:用最新版本的,看不到图标,不知道怎么回事
        8ede20054f59:@hinesboy 你好
        02138a8b61bd:@hinesboy 嗯嗯,解决了,公司网有时上不去github,没看到。
        另外,还有一点小小建议:在开始编辑时要点击第一行才行,体验不是太好
        hinesboy:现在需要单独引入css文件 做了分离 , readme中有demo
      • vfeng:这个得赞一下
      • pfgp2n:顺便是不可以简单介绍下 vue 是个什么东西?很多人应该不是很了解
      • pfgp2n:第一张图加载不出来
        hinesboy:图片更新上去了,github更新改了图片,这边忘记了,不好意思
        pfgp2n:@tamlok 直接能想到的就是可以在自己的网站上做一个在线版MD编辑器。方便有这方面需求的人直接拿来使用
        tamlok: @Alamo_Young 对于md而言,这篇文章的特色是啥呢?

      本文标题:一款强大的Vue-markdown编辑器插件

      本文链接:https://www.haomeiwen.com/subject/dzhhyttx.html