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

相关内容

热门资讯

机巧辅助!wepoker插件辅... 机巧辅助!wepoker插件辅助(辅助)确实是有辅助教程(有挂总结)1、完成wepoker插件辅助辅...
烘培辅助!aapoker安装包... 烘培辅助!aapoker安装包怎么使用(辅助)总是是有辅助神器(有挂猫腻)1、任何aapoker安装...
要领辅助!wepoker透视有... 要领辅助!wepoker透视有吗(辅助)切实是真的有辅助技巧(揭秘有挂)wepoker透视有吗能透视...
讲义辅助!aapoker辅助工... 讲义辅助!aapoker辅助工具安全吗(辅助)好像是有辅助方法(竟然有挂)该软件可以轻松地帮助玩家将...
绝活儿辅助!竞技联盟辅助插件(... 绝活儿辅助!竞技联盟辅助插件(辅助)确实存在有辅助工具(有挂分析)竞技联盟辅助插件破解侠是真的助透视...
指南书辅助!wepoker好友... 指南书辅助!wepoker好友房开挂(辅助)都是有辅助器(讲解有挂)wepoker好友房开挂能透视中...
窍要辅助!wepoker手机版... 窍要辅助!wepoker手机版辅助(辅助)一贯是有辅助神器(今日头条)1、该软件可以轻松地帮助玩家将...
秘籍辅助!德普之星辅助工具如何... 秘籍辅助!德普之星辅助工具如何打开(辅助)真是是有辅助攻略(揭秘有挂)1)德普之星辅助工具如何打开免...
诀窍辅助!wepoker免费脚... 诀窍辅助!wepoker免费脚本(辅助)原来有辅助脚本(有挂方针)1、wepoker免费脚本透视辅助...
步骤辅助!竞技联盟透视插件(辅... 步骤辅助!竞技联盟透视插件(辅助)一贯真的是有辅助app(详细教程)1、全新机制【竞技联盟透视插件a...