mavon-editor 使用

本文档详细介绍了如何在Vue项目中安装和配置Mavon-Editor,包括main.js和vue.config.js的设置,以及在页面中的具体使用方法。同时提供了所需资源文件的下载链接,帮助开发者实现Markdown编辑和预览功能。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

安装

npm install mavon-editor

具体使用

1.main.js 引用
// makDown编辑器
import mavonEditor from 'mavon-editor'
import 'mavon-editor/dist/css/index.css'
Vue.use(mavonEditor)

2.配置vue.config.js
module.exports = {
  /**
   * You will need to set publicPath if you plan to deploy your site under a sub path,
   * for example GitHub Pages. If you plan to deploy your site to https://foo.github.io/bar/,
   * then publicPath should be set to "/bar/".
   * In most cases please use '/' !!!
   * Detail: https://cli.vuejs.org/config/#publicpath
   */
  publicPath: './',
  outputDir: 'dist',
  assetsDir: 'static',
  lintOnSave: process.env.NODE_ENV === 'development',
  productionSourceMap: false,
  devServer: {
    port: port,
    open: true,
    overlay: {
      warnings: false,
      errors: true
    }
  },
  configureWebpack: {
    // provide the app's title in webpack's name field, so that
    // it can be accessed in index.html to inject the correct title.
    name: name,
    resolve: {
      alias: {
        '@': resolve('src')
      }
    },
    /**这边是mavon-editor配置的****/
    plugins: [
      new CopyWebpackPlugin([
        {
          from: 'node_modules/mavon-editor/dist/highlightjs/highlight.min.js',
          to: path.resolve(__dirname, 'dist/markdown/highlightjs') // 插件将会把文件导出在dist/markdown/xxx
        },
        {
          from: 'node_modules/mavon-editor/dist/markdown',
          to: path.resolve(__dirname, 'dist/markdown/markdown')
        },
        {
          from: 'node_modules/mavon-editor/dist/katex',
          to: path.resolve(__dirname, 'dist/markdown/katex')
        }
      ])
    ]
    /**结束****/
  },
  chainWebpack(config) {
    config.plugins.delete('preload') // TODO: need test
    config.plugins.delete('prefetch') // TODO: need test

    // set svg-sprite-loader
    config.module
      .rule('svg')
      .exclude.add(resolve('src/icons'))
      .end()
    config.module
      .rule('icons')
      .test(/\.svg$/)
      .include.add(resolve('src/icons'))
      .end()
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon-[name]'
      })
      .end()
    // set preserveWhitespace
    config.module
      .rule('vue')
      .use('vue-loader')
      .loader('vue-loader')
      .tap(options => {
        options.compilerOptions.preserveWhitespace = true
        return options
      })
      .end()

    config
    // https://webpack.js.org/configuration/devtool/#development
      .when(process.env.NODE_ENV === 'development',
        config => config.devtool('cheap-source-map')
      )

    config
      .when(process.env.NODE_ENV !== 'development',
        config => {
          config
            .plugin('ScriptExtHtmlWebpackPlugin')
            .after('html')
            .use('script-ext-html-webpack-plugin', [{
            // `runtime` must same as runtimeChunk name. default is `runtime`
              inline: /runtime\..*\.js$/
            }])
            .end()
          config
            .optimization.splitChunks({
              chunks: 'all',
              cacheGroups: {
                libs: {
                  name: 'chunk-libs',
                  test: /[\\/]node_modules[\\/]/,
                  priority: 10,
                  chunks: 'initial' // only package third parties that are initially dependent
                },
                elementUI: {
                  name: 'chunk-elementUI', // split elementUI into a single package
                  priority: 20, // the weight needs to be larger than libs and app or it will be packaged into libs or app
                  test: /[\\/]node_modules[\\/]_?element-ui(.*)/ // in order to adapt to cnpm
                },
                commons: {
                  name: 'chunk-commons',
                  test: resolve('src/components'), // can customize your rules
                  minChunks: 3, //  minimum common number
                  priority: 5,
                  reuseExistingChunk: true
                }
              }
            })
          config.optimization.runtimeChunk('single')
        }
      )
  }
}

3.在public文件夹新建markdown文件夹
![在这里插入图片描述](https://img-blog.csdnimg.cn/508a3045434c4e09aefbeb6f887d5b67.png)
github-markdown.min.js
highlight.min.js
katex.min.css
katex.min.js
github.min.css
文件地址:链接:https://pan.baidu.com/s/1Y8HfoxXAsIMMaeYSNoCMlg 
提取码:asdk
4.具体页面使用
<template>
  <mavon-editor
      v-model="value"
      placeholder="请输入内容"
      :subfield="true"
      :toolbars="markdownOption"
      :external-link="externalLink"
    />
</template>
<script>
    let publicPath = ''
    if (process.env.NODE_ENV === 'production') {
      publicPath = '.'
    }
   export default {
      data() {
         return {
              value: '',
              /* markDown*/
              markdownOption: {
                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: false, // 图片链接
                code: true, // code
                table: true, // 表格
                fullscreen: false, // 全屏编辑
                readmodel: false, // 沉浸式阅读
                htmlcode: false, // 展示html源码
                help: false, // 帮助
                /* 1.3.5 */
                undo: true, // 上一步
                redo: true, // 下一步
                trash: true, // 清空
                save: false, // 保存(触发events中的save事件)
                /* 1.4.2 */
                navigation: false, // 导航目录
                /* 2.1.8 */
                alignleft: true, // 左对齐
                aligncenter: true, // 居中
                alignright: true, // 右对齐
                /* 2.2.1 */
                subfield: false, // 单双栏模式
                preview: true // 预览
              },
              externalLink: {
                markdown_css: function() {
                  // 这是你的markdown css文件路径
                  return publicPath + '/markdown/github-markdown.min.css'
                },
                hljs_js: function() {
                  // 这是你的hljs文件路径
                  return publicPath + '/markdown/highlight.min.js'
                },
                hljs_css: false, // 这个css我已经在app.vue中引入了
                katex_css: function() {
                  // 这是你的katex配色方案路径路径
                  return publicPath + '/markdown/katex.min.css'
                },
                katex_js: function() {
                  // 这是你的katex.js路径
                  return publicPath + '/markdown/katex.min.js'
                }
              },
         }
      }
   }
</script>
4.hljs_css: false, // 这个css我已经在app.vue中引入了 app.vue中引入,这个引入文件在百度网盘链接自己提取
<style lang="scss">
  @import './common/css/github.min.css';
</style>
### 集成和配置 mavon-editor 为了在 Vue 3 项目中集成 `mavon-editor`,需要按照特定步骤操作以确保组件能够正常工作并提供预期的功能。 #### 安装依赖包 安装 `mavon-editor` 及其样式文件是第一步。通过 npm 或 yarn 来完成此过程: ```bash npm install mavon-editor --save ``` 或者使用 yarn: ```bash yarn add mavon-editor ``` 这一步骤会下载必要的库到项目的 node_modules 文件夹内[^2]。 #### 引入 mavon-editor 并注册为全局组件 为了让整个应用程序都可以访问 `mavon-editor` 组件,在 main.js 中引入该模块及其 CSS 资源,并调用 `app.use()` 方法来注册这个插件: ```javascript import { createApp } from 'vue' import App from './App.vue' // 导入 mavonEditor 和对应的 css import mavonEditor from 'mavon-editor' import 'mavon-editor/dist/css/index.css' const app = createApp(App) // 使用 mavonEditor 插件 app.use(mavonEditor) app.mount('#app') ``` 这段代码展示了如何将 `mavon-editor` 注册成为全局可用的组件,从而可以在任何地方轻松导入而不必重复定义。 #### 创建富文本编辑器实例 接下来是在页面上创建实际使用的富文本编辑区域。可以通过编写下面这样的模板结构来实现这一点: ```html <template> <div id="editor"> <!-- 这里放置其他 HTML 结构 --> <!-- 添加一个 mavonEditor 实例 --> <mavon-editor v-model="content"></mavon-editor> <!-- 更多的内容可以继续添加在这里 --> </div> </template> <script setup lang="ts"> import { ref, defineComponent } from "vue"; defineComponent({ name: "MyEditor", }); let content = ref(""); </script> ``` 上述代码片段展示了一个简单的例子,其中包含了用于显示/编辑 Markdown 文本的 `<mavon-editor>` 标签,并绑定了一个名为 `content` 的响应式变量作为数据绑定目标。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

沙滩上的一颗石头

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值