vue使用highlight.js及相关记录

最近用vue.js+django做了一个单页blog,用marked.js解析markdown,但是代码没有高亮,看起来很丑。就用highlight.js高亮代码,用法很简单

<link href="http://cdn.bootcss.com/highlight.js/8.0/styles/monokai_sublime.min.css" rel="stylesheet">  
<script src="http://cdn.bootcss.com/highlight.js/8.0/highlight.min.js"></script>  
<script>hljs.initHighlightingOnLoad();</script>

直接三行代码就能实现,然而在单页应用中不能高亮。
查了很多资料知道是vue-router的问题,在路由改变时,页面将会重新渲染并且会移除事件,这里就把 highlight 的事件给移除了。

得到的解决方案是使用 Vue.js 的自定义指令,定义一个v-highlight 的指令来使得 pre code 中的代码高亮。

  #引入必要库
  <link href="http://cdn.bootcss.com/highlight.js/8.0/styles/monokai_sublime.min.css" rel="stylesheet">  
  <script src="http://cdn.bootcss.com/highlight.js/8.0/highlight.min.js"></script>  
      Vue.directive('highlight',function (el) {
        let blocks = el.querySelectorAll('pre code');
        blocks.forEach((block)=>{
          hljs.highlightBlock(block)
        })
      })
      #在要使用高亮的地方使用v-highlight指令
      <div v-html="Marked" v-highlight>
      </div>

到此就能实现高亮了

我的效果图


2222847-4ada38e85940c7a6.png

行号插件工具:https://github.com/wcoder/highlightjs-line-numbers.js/

使用 markdown 来给程序写文档是非常方便的,自从用顺了 markdown 之后,都很久没打开过 Word 了。

既然是程序的文档,少不了需要插入一些示例代码,而对代码进行语法高亮渲染并配以合适的颜色主题,会让文档显得更炫,也更便于阅读。

要实现文档代码高亮渲染其实并不难。

实现方法

首先,把 markdown 文件加载为 vue 组件,这需要一个合适的 loader,自己目前使用 vue-markdown-loader。webpack 配置的 module.rules 中进行如下配置:

        {
            test: /\.md$/,
            loader: 'vue-markdown-loader',
            options: {
                preset: 'default',
                breaks: true,
                preventExtract: true
            }
        }

然后就可以在项目中直接 import md 文件了。比如:

        <template>
            <MyMarkdown/>
        </template>
         
        <script>
        export default {
            components: {
            'MyMarkdown': () => import('xxx.md')
            }
        }
        </script>

当然,通常情况下,我们会与 vue-router 一起使用,把 md 文件作为一个视力组件加载到 router-view 中去。

{
    path: 'path/home',
    component: () => import('../markdown/home.md')
},

看到这里可能奇怪,这些与文题中提到的 highlight.js 有毛关系?这是因为,vue-markdown-loader 中已经内置了对代码高这的支持。你只需要在页面中引入相关的样式,例如:

import 'highlight.js/styles/atom-one-dark.css'

然后主可以看到代码高亮的效果,通常是这样的。

2994823444-5ab60a6526265_articlex.png

看起来还不错,但这样的高亮有个问题,那就是他的背景色并不随着你所加载了 highlight.js 主题样式而改变,而且不同语言的代码在配色上的一些差异也没有很好的渲染出来。而从 highlight.js 官网示例可以看到,这些问题本不应该出现的。

为了实现与 highlight.js 官网示例中的主题效果,可以在页面中自己完成代码高亮的渲染。

    <script>
    import hljs from 'highlight.js'
    import 'highlight.js/styles/atom-one-dark.css'
     
    const highlightCode = () => {
      const preEl = document.querySelectorAll('pre')
     
      preEl.forEach((el) => {
        hljs.highlightBlock(el)
      })
    }
     
    export default {
        mounted () {
        highlightCode()
        },
     
        updated () {
        highlightCode()
        }
    }
    </script>

可以看到,代码中使用了 highlight.js 的 highlightBlock() 方法而不是官方默认示例里提到的 initHighlighting(),因为后者一般用于静态页面的渲染。如果使用它,当使用 vue-router 导航到一个新的‘页面’之后,新页面中的代码块可能无法被正确渲染。这也是为什么在 updated 钩子中再次调用 highlightCode()的原因。(实际上自己在此坑了很久,查阅不少文档才找到这一原因)

做完这些之后再看渲染效果:

222.png

果然好多了!

后记

既然是自己渲染代码高亮,那么其实 loader 中对代码块块的处理就不必要甚至显得有点儿多余了,因为这些处理会增加一些计算量。所以你也可以找一些别的 loader 来替代 vue-markdown-loader,甚至尝试自己写一个 loader。

对于一个软件,官方文档是有必要仔细读的,就像前面提到的 highlight.js 中 initHighlighting() 方法的问题,其实在官方文档中也有解释。


技术博客里,最常见的就是代码了,没有语法高亮的代码,简直没法看下去。

常用的语法高亮 JS 库有 Highlight.jsPrismSyntaxHighlighter 等等,它们的主要工作原理就是搜索 document 中的 <pre><code> 标签,再对其中内容进行正则匹配,识别出使用的语言并为某些内容添加 class,最后根据 CSS 渲染样式。

问题

最近在写一个博客应用(开发中),语法高亮交给前端完成,这里我选择了 Highlight.js 作为语法高亮插件。

因为做的是单页应用,前端框架使用的是 Vue,用 Webpack 作为脚手架,所以很自然地 npm i -S highlight.js 安装,之后把 hljs.initHighlightingOnLoad(); 添加到代码里…

欸?为什么明明 hljs 已经注册为全局变量了,但是高亮不工作?是不是我的姿势不对?

解决

搜索了很多文章,之后发现是 Vue-Router 的锅,在 $route 改变进行跳转时,vue 会重新渲染页面,并移除页面上所有事件。所以在渲染页面后,监听已经被移除了,也就不会再进行语法高亮了。

有两种解决方案:

Vue 自定义指令:

使用 Vue自定义指令,可以在内容渲染时才搜索对应内容中的 <pre><code> 标签,控制更方便。

        import hljs from 'highlight.js';
        Vue.directive('hljs', el => {
          let blocks = el.querySelectorAll('pre code');
          Array.prototype.forEach.call(blocks, hljs.highlightBlock);
        });

使用方法也很简单,在需要进行代码高亮的地方,加上 v-hljs 即可:

<div class="post-content" v-html="postData.content" v-hljs></div>

渲染后重新监听:

        this.getReady(); // Ready
         hljs.initHighlightingOnLoad();

这要根据实际使用情况修改代码,没有第一种方法简单。这里就是在 Ajax 获取数据成功后,重新监听。

FAQ:

Q:为什么明明转换成功了,但是就是不见高亮?

A:Highlight.js 的使用说明比较简陋,不仔细看根本不知道样式文件在 highlight.js/src/styles 文件夹中,并需要自己手动引入。

Q:我明明使用的是 railscasts 的黑底样式,为什么总有一个 github 的白底样式,是不是会自动引入样式的,要怎么配置呢?

A:Highlight.js 不会自动引入样式,也无法配置。遇到这个问题可能是因为 PHP 的 DebugBar 会内置 github 样式,而且会覆盖手动引入的样式,需要关掉 DebugBar 或修改样式文件提高优先级。

参考:

http://www.ahonn.me/2016/07/13/getting-highlightjs-to-work-with-vue.js/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,752评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,100评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,244评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,099评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,210评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,307评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,346评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,133评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,546评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,849评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,019评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,702评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,331评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,030评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,260评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,871评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,898评论 2 351