如何在前端vue3中处理markdown并使用样式和代码高亮
创始人
2024-11-20 09:09:52
0

如何在前端vue3中处理markdown并使用样式和代码高亮

因为想要在前端实现实时渲染markdown,发现找不到对应的处理。搜了很久,终于找到了需要的方法,在这里分享一下

最终效果展示:
在这里插入图片描述

在前端vue3中处理markdown

读取markdown为string文本,然后通过最后markdown-it包转成markdown文件。

markdown-it | markdown-it 中文文档 (docschina.org)

安装依赖:

npm install markdown-it --save 

用法:script setup中

import MarkdownIt from 'markdown-it'  md = new MarkdownIt(); var result = md.render('# markdown-it rulezz!'); //传入文本 

template中直接用v-html绑定:

  

最终在页面显示:

在这里插入图片描述

此时会发现如果有代码的话,代码框没有样式,也没有高亮

导入一些其他的样式应该也是可以的,只需要看文件是怎么用引入的就行

给markdown添加样式

sindresorhus/github-markdown-css:复制 GitHub Markdown 样式的最小 CSS 数量

可以添加GitHub的markdown样式

npm install github-markdown-css 

引入依赖:

import 'github-markdown-css'; 

在生成显示markdown的标签加上对应的class:

  

可以根据需求引入官方这个:

 

然后发现有样式了,但是没有代码高亮

所以还需要加一点东西

wooorm/starry-night: Syntax highlighting, like GitHub

starry-night会生成基于代码高亮的html的hast 树或者css样式,以及自定义语法,具体可以看官方文档。

syntax-tree/hast-util-to-html:将 hast 序列化为 HTML 的实用程序 (github.com)

hast-util-to-html将html的hast 树转成HTML的工具。

两者的结合可以生成高亮的代码html文本

安装依赖:

npm install @wooorm/starry-night 
npm install hast-util-to-html 

官方示例:

import fs from 'node:fs/promises' import {common, createStarryNight} from '@wooorm/starry-night' import {toHtml} from 'hast-util-to-html' import markdownIt from 'markdown-it'  const file = await fs.readFile('example.md') const starryNight = await createStarryNight(common)  const markdownItInstance = markdownIt({   highlight(value, lang) {     const scope = starryNight.flagToScope(lang)      return toHtml({       type: 'element',       tagName: 'pre',       properties: {         className: scope           ? [               'highlight',               'highlight-' + scope.replace(/^source\./, '').replace(/\./g, '-')             ]           : undefined       },       children: scope         ? /** @type {Array} */ (             starryNight.highlight(value, scope).children           )         : [{type: 'text', value}]     })   } })  const html = markdownItInstance.render(String(file))  console.log(html) 

在代码中使用上就有一开始所介绍的效果了。

怎么实时显示流输出的markdown文本数据

可以看一下我写的这篇文章,说得很详细,有我本人写的具体实现:
vue3前端使用ollama搭建本地模型处理流并实时生成markdown-CSDN博客

相关内容

热门资讯

分享个大家!(Wepoke下载... 相信很多朋友都在电脑上玩过Wepoke下载吧,但是很多朋友都在抱怨用电脑玩起来不方便。为此小编给大家...
6分钟了解!(乐乐大连麻将)一... 6分钟了解!(乐乐大连麻将)一直都是有挂吗,福建众娱其实是有猫腻,详细教程(有挂透视)-哔哩哔哩;详...
玩家亲测!微扑克数据原来一直总... 《玩家亲测!微扑克数据原来一直总是有挂,wpk玩胜率高,教你教程(有挂大全)-哔哩哔哩》 微扑克数据...
一分钟了解!Wepoke教程软... 一分钟了解!Wepoke教程软件透明挂,皮皮跑胡子辅助,详细教程(有挂猫腻)-哔哩哔哩;亲真的是有正...
3分钟透视!聚星扑克进去后操作... 3分钟透视!聚星扑克进去后操作,wpk俱乐部有外挂,德州wpk原来是有挂辅助挂(2022已更新)-哔...
一分钟了解!(wpk私人局)w... 一分钟了解!(wpk私人局)wpk ai机器人(软件透明挂)确实有辅助挂原来一直都是有挂(2020已...
3分钟了解!(蜀州麻将大福)真... 3分钟了解!(蜀州麻将大福)真的是有挂吗,微乐福建麻将2025已更新详细教程(有挂方略)-哔哩哔哩是...
二分钟神器!微扑克辅助工具,w... 二分钟神器!微扑克辅助工具,wpk 辅助工具,Wepoke数据有挂其实真的是有挂(2025已更新)-...
一分钟带你了解!Wepoke苹... 一分钟带你了解!Wepoke苹果原来一直总是有挂,线上wpk到底有外挂,爆料教程(有挂细节)-哔哩哔...
6分钟了解!WPK辅助软件透明... 6分钟了解!WPK辅助软件透明挂,海南骨牌有外挂的,详细教程(确实有挂)-哔哩哔哩;1、这是跨平台的...