如何在前端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博客

相关内容

热门资讯

第4分钟了解“四川途游破解安装... 第4分钟了解“四川途游破解安装包”详细透视开挂辅助教程-哔哩哔哩;一、四川途游破解安装包有挂的是的,...
3分钟理解!wepoker透视... 3分钟理解!wepoker透视脚本是什么,We poker辅助器下载,2025新版教程(证实有挂)-...
第八分钟了解(Wepoke苹果... 【福星临门,好运相随】;第八分钟了解(Wepoke苹果)外挂透明挂辅助助手(透视)揭秘攻略(2023...
第十分钟了解“同城游逮狗腿辅助... 第十分钟了解“同城游逮狗腿辅助”详细透视开挂辅助攻略-哔哩哔哩;1、点击下载安装,同城游逮狗腿辅助插...
第4分钟俱乐部!德普之星辅助器... 第4分钟俱乐部!德普之星辅助器,pokemmo脚本,攻略教程(有挂方针)-哔哩哔哩进入游戏-大厅左侧...
第9分钟了解(趣玩玩)外挂辅助... 第9分钟了解(趣玩玩)外挂辅助神器(辅助挂)技巧教程(2026已更新)(哔哩哔哩);是一款可以让一直...
第3分钟了解“广东闲来辅助软件... 第3分钟了解“广东闲来辅助软件”详细透视开挂辅助脚本-哔哩哔哩;1、完成广东闲来辅助软件的残局,帮助...
五分钟了解(八闽十三张)外挂辅... 您好:八闽十三张这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌特别好...
第四分钟神器!有没有人wepo... 第四分钟神器!有没有人wepoker,wpk德州局怎么透视,解密教程(有挂解惑)-哔哩哔哩1、该软件...
7分钟了解“随意玩家透视辅助”... 7分钟了解“随意玩家透视辅助”详细透视开挂辅助软件-哔哩哔哩;人气非常高,ai更新快且高清可以动的一...