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-css和katex僅會在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

 /*
    默認工具欄按鈕全部開啟, 傳入自定義對象
    例如: {
         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

Dependencies (依賴)

• markdown-it

• auto-textarea

• stylus

update(更新內容)

• 更新日志

Collaborators(合作者)

• CHENXCHEN

Licence (證書)

mavonEditor is open source and released under the MIT Licence.

Copyright (c) 2017 hinesboy