Vue3中实现代码高亮的两种方法(prismjs和highlight.js)

 更新时间:2025年04月04日 08:46:11   作者:富朝阳  
最近忙着开发自己的博客系统,在做界面展示的时候,需要让代码高亮,于是经过在网上查阅,发现有两款比较好用的插件实现代码高亮,分别是prismjs和highlight.js,下面我分别介绍下,方便给需要的同学参考

prismjs和highlight.js

prismjs使用

prismjs官网链接

1.安装依赖

//安装prismjs 插件
npm install prismjs -S
 
// vite
npm install vite-plugin-prismjs -D

2.配置vite.config.js 2.配置vite.config.js 

import { prismjsPlugin } from 'vite-plugin-prismjs';
export default defineConfig({
	plugins: [
    	vue(),
    	prismjsPlugin({
      		languages: 'all', // 语言
      		plugins: ['line-numbers', 'copy-to-clipboard'], //官网有其他功能,这里开启行数和复制按钮功能
      		theme: 'okaidia', // 主题
      		css: true,
    	}),
  ],
})

参数解读:

  • line-numbers 显示行数
  • language 显示语言
  • copy-to-clipboard 复制功能
  • inline-color 代码中显示颜色块

3.html使用

 设置语言只需要在class="language-语言",比如如下js设置language-js即可

<template>
  <pre><code class="language-js line-numbers">{{ codes }}</code></pre>
</template>
 
<script lang="ts">
import { defineComponent } from 'vue';
import Prism from 'prismjs';
export default defineComponent({
  name: 'HtmlRender',
  setup() {
    onMounted(() => {
      Prism.highlightAll(); // 切换更新内容则重新调用这个方法
    });
  }
});
</script>

注意: pre 和 code 写在同一行(不然行号会错乱)

效果图:

4.额外扩展

如果你想用Mac分格的样式,则需要自定义pre样式,如下是我自己的,大家可做参考:

pre {
    overflow: hidden !important;
    code{ 
        display: inline-block;
        padding-bottom: 20px;
        position: relative;
        top: 20px;
    }
    &::before {
        content: "";
        position: absolute;
        background: red;
        width: 10px;
        height: 10px;
        border-radius: 50%;
        top: 10px;
        left: 15px;
        transform: translate(-50%);
    }
    &::after {
        content: "";
        position: absolute;
        background: sandybrown;
        width: 10px;
        height: 10px;
        border-radius: 50%;
        top: 10px;
        left: 30px;
        transform: translate(-50%);
    }
    code:first-child{
        &::after{
            content: "";
            position: absolute;
            background: limegreen;
            width: 10px;
            height: 10px;
            border-radius: 50%;
            top: -24px;
            left: -7px;
            transform: translate(-50%);
        }
    }
}

如果你到了这一步,那代表你使用prismjs实现的的代码块样式功能完美实现啦!恭喜恭喜! 

highlight使用

1.安装依赖

npm install highlight.js --save 或 yarn add highlight.js

2.在main.js中引入,官方为我们提供了vue到插件

// highlight 的样式,依赖包,组件
import hljs from "highlight.js";
import "highlight.js/styles/github.css";
 
const app = createApp(App);
app.use((app) => {
    app.directive("highlight", {
      mounted(el) {
        const blocks = el.querySelectorAll("pre code"); // querySelectorAll可以根据自己的富文本生成的代码做调整 我这里默认刚好
        blocks.forEach((block: any) => {
          // 在forEach中做一些操作
          // 1.创建ul节点
          const ul = document.createElement("ul");
          // 2.根据换行符获取行数,根据获取的行数生成行号
          const rowCount = block.outerHTML.split("\n").length;
          for (let i = 1; i <= rowCount; i++) {
            //创建li节点,创建文本节点
            const li = document.createElement("li");
            const text = document.createTextNode(String(i));
            //为li追加文本节点,将li加入ul
            li.appendChild(text);
            ul.appendChild(li);
          }
          // 3.给行号添加类名
          ul.className = "pre-numbering";
          // 4.将ul节点加到 代码块
          block.parentNode.appendChild(ul);
          hljs.highlightBlock(block);
        });
      },
    });
  })
  .mount("#app");

3.css行数样式自定义

我们对显示行数做了扩展,css如下 

pre {
  position: relative;
  background-color: #fafafa;
  font-size: 14px;
  padding: 8px 8px 0px 8px;
  overflow: hidden;
  border: 1px solid #ccc;
}
 
code.hljs {
  background-color: #fafafa !important;
  line-height: 22px;
  padding: 0 0 0.5em 2.2em !important;
  white-space: unset;
}
 
.pre-numbering {
  position: absolute;
  top: 8px;
  left: 0;
  width: 30px;
  border-right: 1px solid #c5c5c5;
  background-color: #fafafa;
  text-align: center;
  line-height: 22px;
}
 
.pre-numbering li {
  list-style: none;
  color: #383a42;
  font-size: 14px;
}

行数以及背景显示样式可以根据自己的需求自定义

注意点: 

设置行数样式中,有人反应高亮的代码死活就是错位显示,正常没有库样式覆盖pre参照以上样式基本没问题,如果引入其他css库覆盖可能是pre下面的code设置了white-space: pre-wrap;换行导致错位展示问题,重点排查样式覆盖问题。

4.html中使用

<highlightjs language='javascript' code="var x = 5;" />

如果你到了这一步,那代表你使用highlight实现的代码块样式功能完美实现啦!恭喜恭喜!

总结

prismjs和highlight.js两个插件感觉都很不错,个人比较喜欢prismjs,当然萝卜青菜各有所爱,大家根据自己的爱好选择即可。

到此这篇关于Vue3实现代码高亮的两种方法(prismjs和highlight.js)的文章就介绍到这了,更多相关Vue3 prismjs和highlight.js代码高亮内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 基于vue-cli3创建libs库的实现方法

    基于vue-cli3创建libs库的实现方法

    这篇文章主要介绍了基于vue-cli3创建libs库的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • Vue-Router的routes配置详解

    Vue-Router的routes配置详解

    在使用vue-router的项目中,实例化VueRouter是其配置选项routes该选项指定路由与视图的组件的关系或者路由与其他路由的关系,Router配置选项中是其中最重要的配置。本文就详细的介绍一下
    2021-10-10
  • Vue使用echarts可视化组件的方法

    Vue使用echarts可视化组件的方法

    这篇文章主要介绍了Vue使用echarts可视化组件的方法,本文通过实例代码案例给大家详细介绍,需要的朋友可以参考下
    2021-07-07
  • vue--vuex详解

    vue--vuex详解

    这篇文章主要介绍了vue--vuex的详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • vue ssr 指南详读

    vue ssr 指南详读

    这篇文章主要介绍了vue ssr 指南详读,详细的介绍了什么是SSR以及如何使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • Vue 组件(component)教程之实现精美的日历方法示例

    Vue 组件(component)教程之实现精美的日历方法示例

    组件是我们学习vue必须会的一部分,下面这篇文章主要给大家介绍了关于Vue 组件(component)教程之实现精美的日历的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-01-01
  • 使用Vue创建前后端分离项目的完整过程(前端部分)

    使用Vue创建前后端分离项目的完整过程(前端部分)

    这篇文章主要介绍了使用Vue.js和Node.js搭建一个前端和后端分离的项目,并使用VueCLI3脚手架、axios进行HTTP请求、Vue-router实现前端路由和vuex进行状态管理,需要的朋友可以参考下
    2025-01-01
  • element-ui循环显示radio控件信息的方法

    element-ui循环显示radio控件信息的方法

    今天小编就为大家分享一篇element-ui循环显示radio控件信息的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-08-08
  • vue实现触底查询功能

    vue实现触底查询功能

    这篇文章主要为大家详细介绍了vue实现触底查询功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Vue使用konva实现一个简便的流程图

    Vue使用konva实现一个简便的流程图

    日常开发中我们可能碰到流程图的需求,实现流程图的库有很多,如果我们想要实现一个简便的流程图可以使用konva库来实现,下面我们就来看一下具体的实现过程,需要的朋友可以参考下
    2023-08-08

最新评论