vue3引入highlight.js進行代碼高亮的方法實例

更新時間：2022年04月08日 09:51:30 作者：友人喵咪老師

最近忙著開發(fā)自己的開發(fā)腳手架,在做代碼生成器的時候,有個預覽功能,需要讓代碼高亮,下面這篇文章主要給大家介紹了關于vue3引入highlight.js進行代碼高亮的相關資料,需要的朋友可以參考下

背景描述：

在項目開發(fā)中，經(jīng)常一些日志預覽，還有文件的預覽，需要進行代碼高亮顯示。這樣可以讓文本內(nèi)容展示的時候顯得更加友好，也便于閱讀

效果類似markdown語法的代碼高亮，如下：

    <TestPlan guiclass="TestPlanGui" testclass="TestPlan" testname="自動化測試">
      <stringProp name="TestPlan.comments"></stringProp>
      <boolProp name="TestPlan.functional_mode">false</boolProp>
      <boolProp name="TestPlan.tearDown_on_shutdown">true</boolProp>
      <boolProp name="TestPlan.serialize_threadgroups">false</boolProp>
      <elementProp name="TestPlan.user_defined_variables" elementType="Arguments">
        <collectionProp name="Arguments.arguments"/>
      </elementProp>
    </TestPlan>

一、安裝依賴：

注意：我們需要安裝的依賴有兩個，網(wǎng)上的博文，都是寫的一個，比較坑。
npm install --save highlight.js
npm install --save @highlightjs/vue-plugin
命令行如下

## 這個是highlight.js基礎依賴
npm install --save highlight.js
## 安裝支持vue3 的@highlightjs/vue-plugin 依賴
npm install --save @highlightjs/vue-plugin

二、在vue3主入口main文件，對highlight進行引入和注冊：

需要引入的有
樣式，在main主入口引入樣式為全局統(tǒng)一都使用這個樣式，也可以在單獨的頁面引入，你想要的樣式。樣式效果參考官網(wǎng)：https://highlightjs.org/static/demo/
更改 import ‘highlight.js/styles/atom-one-dark.css’ 把styles 后面的值改成你想要的樣式就行依賴包組件

# --- 文件src/main.ts | src/main.js 
# highlight 的樣式，依賴包，組件
import 'highlight.js/styles/atom-one-dark.css'
import 'highlight.js/lib/common'
import hljsVuePlugin from '@highlightjs/vue-plugin'

import { computed, createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

// 引入代碼高亮，并進行全局注冊
app.use(hljsVuePlugin)
app.mount('#app')

三、頁面使用：

    <!-- 把數(shù)據(jù)綁定到 `code` 屬性-->
    <highlightjs autodetect :code="code" />
    <!--或者直接將顯示的代碼寫到 `code`中 -->
    <highlightjs language='javascript' code="var x = 5;" />

示例如下：
可以使用 language 指定具體的語言，如javascript、xml等
這個值省略，highlightjs 也會自動識別對應的語言

四、看下效果展示吧：

五、一些優(yōu)化：

1.問題

可以看到生成的代碼是pre包裹的，會有個1rem 的margin-bottom，效果不是很好

2.解決方法

在對應的頁面，使用style 標簽，對樣式進行重寫，注意不要加 scoped

<style lang="scss">
pre {
  margin-bottom: 0;
}
</style>

3. 處理后的效果

這個是示例，當然你們可以根據(jù)實際的項目進行樣式改造
碼字不容易，對你有幫助的話，給個點贊吧 ? (????)
更多詳情，請查閱官方文檔，
官網(wǎng)鏈接：https://highlightjs.org/
官網(wǎng)github鏈接：https://github.com/highlightjs/vue-plugin