Vue编写markdown或者展示markdown

最新推荐文章于 2024-07-02 14:31:38 发布
最新推荐文章于 2024-07-02 14:31:38 发布
阅读量2.9w 收藏 95
点赞数 21
分类专栏： vue 文章标签： mavonEditor markdown vue blog 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wn1245343496/article/details/82147850
版权

之前做博客开发的时候，需要markdown的支持，找了很多资料，但是都是七拼八凑的，要么是告诉你怎么编写markdown，要么是告诉你怎么展示，我把它们总结一下。

1、介绍mavonEditor

官网：https://md.zhystar.com/
github：https://github.com/hinesboy/mavonEditor

mavonEditor是基于Vue的markdown 编辑器插件，支持自定义界面，代码高亮，图片上传，这些在github中都有写到，相关资料可以去github查看

2、安装mavonEditor

$ npm install mavon-editor --save 或者
$ yarn add mavon-editor

在main.js中

import mavonEditor from 'mavon-editor'
import 'mavon-editor/dist/css/index.css'
Vue.use(mavonEditor)

3、使用mavonEditor编辑markdown

在.vue文件中

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

<script>
export default {
    data() {
        return {
            value: '',
            defaultData: "preview"
        };
    },
};
</script>

打开页面显示可编辑的页面
这里写图片描述

4、使用v-html展示markdown


<article v-html="value" ></article>

<script>
export default {
    data() {
        return {//value的值是经过markdown解析后的文本，可使用`@change="changeData"`在控制台打印显示
            value: `<blockquote>
									<p>你好</p>
									</blockquote>
									<p><code>java</code></p>`,
            defaultData: "preview"
        };
    },
    methods: {
    }
};
</script>

以下取自官网，查看详细信息请移步官网

API 文档

props

name 名称type 类型default 默认值describe 描述
valueString初始值
languageStringzh-CN语言选择，暂支持 zh-CN: 中文简体 ， en: 英文 ， fr: 法语, pt-BR: 葡萄牙语, ru: 俄语
fontSizeString15px编辑区域文字大小
scrollStyleBooleantrue开启滚动条样式(暂时仅支持chrome)
boxShadowBooleantrue开启边框阴影
subfieldBooleantruetrue： 双栏(编辑预览同屏)， false： 单栏(编辑预览分屏)
defaultOpenStringedit： 默认展示编辑区域 ， preview： 默认展示预览区域 , 其他 = edit
placeholderString开始编辑…输入框为空时默认提示文本
editableBooleantrue是否允许编辑
codeStyleStringcode-githubmarkdown样式： 默认github, 可选配色方案
toolbarsFlagBooleantrue工具栏是否显示
navigationBooleanfalse默认展示目录
ishljsBooleantrue代码高亮
imageFilterfunctionnull图片过滤函数，参数为一个File Object，要求返回一个Boolean, true表示文件合法，false表示文件不合法
imageClickfunctionnull图片点击事件，默认为预览，可覆盖
toolbarsObject如下例工具栏
 /*
    默认工具栏按钮全部开启, 传入自定义对象
    例如: {
         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 描述
changeString: value , String: render编辑区发生变化的回调事件(render: value 经过markdown解析后的结果)
saveString: value , String: renderctrl + s 的回调事件(保存按键,同样触发该回调)
fullScreenBoolean: status , String: value切换全屏编辑的回调事件(boolean: 全屏开启状态)
readModelBoolean: status , String: value切换沉浸式阅读的回调事件(boolean: 阅读开启状态)
htmlCodeBoolean: status , String: value查看html源码的回调事件(boolean: 源码开启状态)
subfieldToggleBoolean: status , String: value切换单双栏编辑的回调事件(boolean: 双栏开启状态)
previewToggleBoolean: status , String: value切换预览编辑的回调事件(boolean: 预览开启状态)
helpToggleBoolean: status , String: value查看帮助的回调事件(boolean: 帮助开启状态)
navigationToggleBoolean: status , String: value切换导航目录的回调事件(boolean: 导航开启状态)
imgAddString: filename, File: imgfile图片文件添加回调事件(filename: 写在md中的文件名, File: File Object)
imgDelString: filename图片文件删除回调事件(filename: 写在md中的文件名)
代码高亮

如不需要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, defaultOpen: "preview"

快捷键

keykeycode功能
F8119开启/关闭导航
F9120预览/编辑切换
F10121开启/关闭全屏
F11122开启/关闭阅读模式
F12123单栏/双栏切换
TAB9缩进
CTRL + S17 + 83触发保存
CTRL + D17 + 68删除选中行
CTRL + Z17 + 90上一步
CTRL + Y17 + 89下一步
CTRL + BreakSpace17 + 8清空编辑
CTRL + B17 + 66加粗
CTRL + I17 + 73斜体
CTRL + H17 + 72# 标题
CTRL + 117 + 97 or 49# 标题
CTRL + 217 + 98 or 50## 标题
CTRL + 317 + 99 or 51### 标题
CTRL + 417 + 100 or 52#### 标题
CTRL + 517 + 101 or 53##### 标题
CTRL + 617 + 102 or 54###### 标题
CTRL + U17 + 85++下划线++
CTRL + M17 + 77标记
CTRL + Q17 + 81> 引用
CTRL + O17 + 791. 有序列表
CTRL + L17 + 76链接
CTRL + ALT + S17 + 18 + 83上角标
CTRL + ALT + U17 + 18 + 85- 无序列表
CTRL + ALT + C17 + 18 + 67```代码块
CTRL + ALT + L17 + 18 + 76图片链接
CTRL + ALT + T17 + 18 + 84表格
CTRL + SHIFT + S17 + 16 + 83下角标
CTRL + SHIFT + D17 + 16 + 68中划线
CTRL + SHIFT + C17 + 16 + 67居中
CTRL + SHIFT + L17 + 16 + 76居左
CTRL + SHIFT + R17 + 16 + 82居右
SHIFT + TAB16 + 9取消缩进
梦里谁知身是客
关注
  • 21
    点赞
  • 踩
  • 95
    收藏
    觉得还不错? 一键收藏
  • 36
    评论
专栏目录
vue使用Markdown编辑器
SeeU
08-27 237
1. 安装 安装 mavon-editor:npm install mavon-editor --save 加粗样式 2. 引入、配置 在要使用markdown编辑器的组件内操作： <script> // 导入组件 及 组件样式 import { mavonEditor } from 'mavon-editor' import 'mavon-editor/dist/css/index.css' </script> 3 使用 **注意： 绑定model 实时改变：
vue中展示markdown文件
01-18
vue中展示markdown文件，使用mavon-editor的详细步骤
Vue-Markdown：高效渲染Markdown的Vue组件
gitblog_00086的博客
03-24 1522
Vue-Markdown：高效渲染Markdown的Vue组件 vue-markdownvue-markdown: 是一个用于Vue.js的Markdown渲染器组件，允许在Vue应用中轻松展示Markdown格式的内容。项目地址:https://gitcode.com/gh_mirrors/vu/vue-markdown 是一个强大的Vue.js组件，用于将Markdown文本优雅地转换为HT...
Vue实现Markdown文件内容显示及代码块高亮
最新发布
我就是我是好孩子的博客
07-02 582
用到的插件有： marked、 highlight.js、 github-markdown-css。如果想要给代码块加上行号，可以参考官网：https://highlightjs.org/开始使用(不要忘记在标签内的 class 写入 markdown-body)根据自定义代码块的标签类添加自己想要的样式。安装highlight.js。
推荐一款基于Vue的Markdown编辑器插件——mavonEditor
weixin_34279061的博客
04-21 2980
github地址 演示地址 特点 支持简体中文、英语、法语、西班牙语四种语言 移动端适配 语法拓展全面 支持图片上传 文档丰富、功能丰富且可配置 mavonEditor 基于Vue的markdown编辑器 English Documents Demo for jsfiddle example (图片展示) PC Install mavon-editor (安装) $ npm ...
Vue使用markdown编辑器
qq_45914437的博客
04-14 683
笔记
vue使用markdown编辑器
weixin_42324665的博客
06-24 347
在vue中使用markwoen 安装markdown npm install --save mavon-editor 在main.js中引入并注册 import mavonEditor from 'mavon-editor'; //css样式一定要引入 import 'mavon-editor/dist/css/index.css'; Vue.use(mavonEditor); 组件中 //dom <mavon-editor :toolbars="markdownOption" v-m
Vue 使用 Markdown标记语言编辑器（MavonEditor）
@必意玲
05-24 834
文章目录1. 实现效果2. 直接撸 `MavonEditor`，上代码2.1 npm安装 MavonEditor2.2 在需要使用Markdown的Vue组件导入mavonEditor2.3 vue页面使用3. 参考 1. 实现效果 本篇文章的实现效果图如下 2. 直接撸 MavonEditor，上代码 2.1 npm安装 MavonEditor npm install mavon-editor --s 2.2 在需要使用Markdown的Vue组件导入mavonEditor import { mavo
vue-markdown-editor：基于Vue构建的markdown编辑器
02-04
基于Vue构建的Markdown编辑器 链接 通讯 QQ群：798884474 安装 # use npm npm i @kangc/v-md-editor -S # use yarn yarn add @kangc/v-md-editor 快速开始 import Vue from 'vue' ; import VueMarkdownEditor from '...
markdown-it-vue：markdown-it的vue库
02-04
markdown-it的Vue库。 在线演示 安装 npm install markdown-it-vue 支持 图像大小和查看器 官方降价语法。 GFM目录 GFM风格 表情符号 仅简单 Flowcharts.js 下标/上标 信息| 错误警告信息提示 插件清单 降价 ...
实现Vue的markdown文档可以在线运行的方法示例
12-01
markdown 文档中Vue代码 可执行啦，而且可以边看边执行。这样就可以用markdown文档的形式，写自己的Vue博客了， 可以方便介绍自己的原创组件，很酷的执行。 Github ...
基于VUE的markdown文本编辑器
08-10
基于VUE的markdown文本编辑器
一款强大的基于Vue的markdown编辑器插件.zip
09-24
一款强大的基于Vue的markdown编辑器插件.zip,mavonEditor - A markdown editor based on Vue that supports a variety of personalized features
一个基于Vue的markdown编辑器应用
08-10
一个基于Vue的markdown编辑器应用
vuemarkdown高亮插件
08-10
3. 使用：在Vue组件中，你可以直接使用Markdown语法编写文本，插件会自动处理代码高亮。例如： ```html <div v-html="markdownText"></div> export default { data() { return { markdownText: `##...
vue中使用markdown编辑器
qq_37809572的博客
08-19 1805
转自：https://www.jianshu.com/p/474197c1f7cc谨用于记录 Markdown 介绍 1. 什么是Markdown   首先，各位框架玩家一定不会陌生，因为无论是在各类框架下还是开源项目中，都会有一个.md的文件，该文件一般是项目说明文件，不仅语法简洁，而且所生成的“页面”也要比普通标记语言更加整洁明了。那么它到底是什么呢？   Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。   Markdow..
Vue 中使用markdown编辑器
sdrfghb的博客
11-15 759
【代码】Vue 中使用markdown编辑器。
Vue Markdown编辑器
Quit_Ethereal的博客
02-14 5392
效果展示 简介 一款使用marked和highlight.js开发的一款markdown编辑器，除常见markdown语法外，支持快捷输入、图片粘贴、代码复制、全屏编辑、预览等功能。 使用起来简单方便，只需几行代码，即可在你的页面上引入一个markdown编辑器，编辑区支持像专业编辑器那样。 线上预览地址 https://wikecloud.com/md git地址 https://gitee.com/wike2019/wike__md_editor 特点 方便扩展，根据实际需求，支持常见的功能配置，也可
vue-markdown
07-13
Vue-Markdown 是一个 Vue.js 的插件，它可以将 Markdown 格式的文本转换为 HTML，并以可视化的方式呈现在浏览器中。 使用 Vue-Markdown，你可以在 Vue 组件中轻松地将 Markdown 文本渲染为可视化的内容。它提供了许多配置选项，使你能够自定义渲染的样式和行为。 下面是一个简单的示例，展示了如何在 Vue 组件中使用 Vue-Markdown： 首先，安装 Vue-Markdown： ``` npm install vue-markdown ``` 然后，在你的 Vue 组件中引入并使用 Vue-Markdown： ```vue <template> <div> <vue-markdown :source="markdownText"></vue-markdown> </div> </template> <script> import VueMarkdown from 'vue-markdown'; export default { components: { VueMarkdown }, data() { return { markdownText: '# Hello, Vue-Markdown!' }; } }; </script> ``` 在上面的示例中，我们将一个 Markdown 格式的标题渲染为了一个 H1 标签。你可以根据自己的需求使用更复杂的 Markdown 内容，并根据需要进行自定义配置。 Vue-Markdown 还提供了其他一些有用的功能，例如语法高亮、自定义组件和插件等。你可以在官方文档中了解更多关于 Vue-Markdown 的详细信息和用法。 希望这能帮助到你！如有更多问题，请随时提问。
评论 36
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值