使用Vue指令实现Markdown渲染和代码高亮

 更新时间:2023年09月21日 08:49:02   作者:ErvinHowell  
在前端开发中,我们经常需要将Markdown格式的文本渲染成HTML并展示在页面上,同时还希望能够对代码块进行高亮显示,今天我将分享一段代码,通过Vue指令实现了这个功能,需要的朋友可以参考下

在前端开发中,我们经常需要将Markdown格式的文本渲染成HTML并展示在页面上,同时还希望能够对代码块进行高亮显示。今天我将分享一段代码,通过Vue指令实现了这个功能。

首先,你需要安装一些依赖。在你的项目中执行以下命令:

pnpm add highlight.js marked @types/marked -D

接下来,我们来看一下具体的代码实现。

main.ts文件中,我们需要注册一个全局的Vue指令。代码如下:

import { markedDirective } from './path/to/markedDirective'
app.directive('marked', markedDirective)

在Vue组件中,你可以使用v-marked指令来渲染Markdown文本,并对代码块进行高亮显示。示例代码如下:

<template>
  <div v-marked:hl="code"></div>
</template>
<script setup lang="ts">
import 'highlight.js/styles/atom-one-dark.css'
import code from '@/config/code.md?raw'
</script>

上面的示例代码中,我们导入了highlight.js的样式文件,并且使用code.md文件中的Markdown文本作为示例。

接下来,让我们来看一下具体的实现代码。

首先,我们需要导入highlight.jsmarked模块,代码如下:

import hljs from 'highlight.js'
import { marked } from 'marked'
import { Directive, DirectiveHook, nextTick } from 'vue'

然后,我们需要创建一个marked的渲染器,并设置一些选项,代码如下:

const render = new marked.Renderer()
marked.setOptions({
  renderer: render,
  gfm: true,
  pedantic: false
})

在Vue指令的具体实现中,我们定义了一个formatValue函数,该函数用于将Markdown文本渲染成HTML,并对代码块进行高亮显示。代码如下:

const formatValue: DirectiveHook = async (el, binding) => {
  const html = marked(binding?.value ?? '')
  el.innerHTML = html
  await nextTick()
  if (binding.arg === 'hl') {
    const blocks = el.querySelectorAll('pre code')
    blocks.forEach((block: any) => {
      hljs.highlightBlock(block)
    })
  }
}

最后,我们将formatValue函数作为Vue指令的mountedupdated钩子的回调函数。这样,每当指令所绑定的值发生变化时,都会重新渲染Markdown文本并对代码块进行高亮显示。代码如下:

export const markedDirective: Directive = {
  mounted: formatValue,
  updated: formatValue
}

到此为止,我们已经完成了整个功能的实现。

总结一下,通过上述代码,我们可以在Vue项目中使用v-marked指令将Markdown文本渲染成HTML,并对其中的代码块进行高亮显示。这对于展示文档、博客等场景非常有用。

以上就是使用Vue指令实现Markdown渲染和代码高亮的详细内容,更多关于Vue Markdown渲染和代码高亮的资料请关注脚本之家其它相关文章!

相关文章

  • vue项目中less的一些使用小技巧

    vue项目中less的一些使用小技巧

    前段时间一直在学习vue,开始记录一下遇到的问题,下面这篇文章主要给大家介绍了关于vue项目中less的一些使用小技巧,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2021-09-09
  • VUE+jszip如何实现下载多个文件导出为一个zip格式

    VUE+jszip如何实现下载多个文件导出为一个zip格式

    这篇文章主要介绍了VUE+jszip如何实现下载多个文件导出为一个zip格式方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • 页面tooltip组件限制工具函数使用示例详解

    页面tooltip组件限制工具函数使用示例详解

    这篇文章主要为大家介绍了页面tooltip组件的限制工具函数使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • 详解vue过度效果与动画transition使用示例

    详解vue过度效果与动画transition使用示例

    Vue 在插入、更新或者移除 DOM 时,提供多种不同方式的应用过渡效果,Vue 提供了内置的过渡封装组件transition,该组件用于包裹要实现过渡效果的组件
    2021-10-10
  • vue-router子路由的实现方式

    vue-router子路由的实现方式

    这篇文章主要介绍了vue-router子路由的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • elementUI踩坑记录-el-table问题

    elementUI踩坑记录-el-table问题

    这篇文章主要介绍了elementUI踩坑记录-el-table问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • vue中插槽整理及用法分析

    vue中插槽整理及用法分析

    在本篇文章里小编给大家整理的是一篇关于vue中插槽整理及用法分析内容,对此有兴趣的朋友们可以跟着学习下。
    2021-12-12
  • <el-button>点击后如何跳转指定url链接

    <el-button>点击后如何跳转指定url链接

    这篇文章主要介绍了<el-button>点击后如何跳转指定url链接问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • 详细讲解vue2+vuex+axios

    详细讲解vue2+vuex+axios

    在vue2项目中,组件间相互传值或者后台获取的数据需要供多个组件使用的情况很多的情况下(后台获取数据存入vuex,组件之间共享数据),那么就需要用vuex来管理这些。
    2017-05-05
  • 利用Vue2.x开发实现JSON树的方法

    利用Vue2.x开发实现JSON树的方法

    这篇文章主要给大家介绍了关于利用Vue2.x开发实现JSON树的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-01-01

最新评论