使用highlight.js高亮你的代碼

来源:http://www.cnblogs.com/ermu-learn/archive/2016/10/24/5993025.html
-Advertisement-
Play Games

在逛別人的博客的時候,看見別人的代碼的例子使用了高亮的語法,無論是java,js還是php等等語言,都會自動的對關鍵字進行高亮。 於是在前幾天自己寫了一個博客,遇到code時,自然就想到了別人網站如何漂亮,巴拉巴拉。 開始了正式的搗鼓。 在搗鼓之前去別的網站看了看。這裡貼上簡書的效果: 其中的關鍵字 ...


在逛別人的博客的時候,看見別人的代碼的例子使用了高亮的語法,無論是java,js還是php等等語言,都會自動的對關鍵字進行高亮。

於是在前幾天自己寫了一個博客,遇到code時,自然就想到了別人網站如何漂亮,巴拉巴拉。

開始了正式的搗鼓。

在搗鼓之前去別的網站看了看。這裡貼上簡書的效果:

其中的關鍵字,方法名,字元串都有不同的顏色,雖然這個代碼高亮得不是很好看,但還過得去。於是去看了看document,發現是這樣的:

<pre class="hljs javascript"><code class="javascript"><span class="hljs-function"><span class="hljs-keyword">function</span>  <span class="hljs-title">getPersonInfo</span>(<span class="hljs-params">name,age,sex</span>) </span>{
    <span class="hljs-built_in">console</span>.log(name+age+sex);
}
<span class="hljs-comment">//要是我這樣傳,name就成了18,age成了王二了。</span>
getPersonInfo(<span class="hljs-string">'18'</span>,<span class="hljs-string">'王二'</span>,<span class="hljs-string">'男'</span>);
<span class="hljs-comment">//所以可以這樣寫</span>
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">getPersonInfo</span>(<span class="hljs-params">args</span>)</span>{
    <span class="hljs-built_in">console</span>.log(args.name+args.age+args.sex);
}
getPersonInfo({name:<span class="hljs-string">'王二'</span>,age<span class="hljs-string">'18'</span>,sex:<span class="hljs-string">'男'</span>});</code></pre>

hljs??絕對就是這貨了。於是找到了我們的主角:highlight.js。

highlight.js官網

highlightjs的用法可以直接在官網裡look

這裡我主要寫下自己在使用過程中踩到些什麼坑,以及最終的解決辦法。

1.心急吃不了熱豆腐,萬事開頭最是難

根據官網的doc,只需要三行代碼就可以使用了,非常方便,自己寫了個小demo測試了一下。還是很有效果的。

<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>  

這裡使用了bootstarp提供的cdn,可以直接通過上面的連接來訪問cdn,選擇需要的版本。就是那麼簡單。

這個配色也不是很好看。想要好看的配色可以直接在官網中參考。https://highlightjs.org/static/demo/

2.好用就要應用到實際開發中去

如此簡單就可以應用非常的開心,於是應用到了項目中去。

結果遇到了大麻煩....

項目中使用了require.js來載入js,整個應用用的又是angular的框架。

如果直接這樣寫明顯不符合規範,於是將代碼變通一下,使用require.js來載入highlight.js。

在require.config中增加highlight的路徑配置

'highlight':'http://cdn.bootcss.com/highlight.js/8.0/highlight.min',

在require的回調函數中執行hljs.initHighlightingOnLoad();

require(loadList, function ($, angular) {
        $(function () {
            angular.bootstrap(document, ['blogApp']);
        });
        hljs.initHighlightingOnLoad();
    });

css還是通過link,也可以使用less的@import載入,因為項目用了less,所以我選擇了@import

@import "/lib/highlight/styles/tomorrow-night-eighties.css";

然後在html頁面寫一個code測試:

<body>
        <div ng-include="'template/header.html'"></div>
        <div>
            <pre>
                <code class="lang-javascript">
        function init(){
            $scope.req.getArticle();
            $('pre code').each(function(i, block) {
                hljs.highlightBlock(block);
            });
        }
                </code>
            </pre>
        </div>
        <div class="content" ui-view></div>
        <footer>cloud blog by@ermu </footer>
    </body>

然後打開瀏覽器一看:

灰常完美。

但是當使用了ng-bind-html,來顯示從後臺返回的文檔時:

代碼完全不高亮了。仔細想想,

hljs.initHighlightingOnLoad();
不就是onload的時候執行渲染麽,也就是說,在此之後改變document都不會在執行了。所以很顯然這樣並不能高亮從介面取會來的文檔的代碼。

google了一下,有一個叫angular-highlightjs 的東西,嘗試了使用,但一直報錯,官網上也沒有什麼說明文檔

幸好代碼托管到了github上面,於是去上面看了看,發現使用說明和官網一樣短,issues上也沒有人問這個問題,於是我問了一下,希望有人能解答:問題地址

我想highlight.js一定有提供對應的方法,在載入完成之後還可以執行一次,但無奈api文檔是英文的,看得比較吃力,決定還是想別的法子。

最終解決問題的方法是介面返回使用highlight.js編譯好的html,因為後端使用的是node,於是在cnode論壇上搜了一下,發現marked已經解決了這個問題。

只需要在marked的配置中添加highlight項即可(要先npm install highlight.js):
var marked = require('marked');
var highlight = require('highlight.js');
marked.setOptions({
    renderer: new marked.Renderer(),
    gfm: true,
    tables: true,
    breaks: false,
    pedantic: false,
    sanitize: false,
    smartLists: true,
    smartypants: false,
    highlight: function (code) {
    return highlight.highlightAuto(code).value;
  }
});
返回的文檔已經添加了對應的class。
<pre>
<code class="lang-js">
<span class="hljs-keyword">var</span> math = (<span class="hljs-string">'math'</span>) ;
<span class="hljs-keyword">export</span>.increment = <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">val</span>) </span>{
    <span class="hljs-keyword">return</span> math.add(val,<span class="hljs-number">1</span>)
}
</code>
</pre>

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 本文主要論述設計模式中代理模式的原理和代碼實現,其中包含靜態代理和動態代理。 ...
  • 每天一個設計模式-6 抽象工廠模式 1.生活的例子 組裝CPU主板時需要針腳匹配,那麼CPU和主板之間就有了關係,這也是和工廠方法模式的區別;抽象工廠的功能是為一系列相關對象或相互依賴的對象創建一個藉口,對象之間存在約束。工廠方法則是創建單個產品對象。 2.抽象工廠的定義 提供一個創建一系列相關或相 ...
  • 首先我們進一步理解什麼是對象關係映射模型? 它將對資料庫中數據的處理轉化為對對象的處理。如下圖所示: 入門簡單實例: hiberante 可以用在 j2se 項目,也可以用在 j2ee (web項目中),而struts是web框架,所以用在 web項目。 hibernate開發方式的主要兩種方式: ...
  • 哇,這個可以輕鬆實現輸入值就按鈕可點擊,輸入框沒有值則不可點擊的狀態呀 看代碼 so easy~~~這個功能實現的,就是比如像就是提交表單的時候的需求,就是要是你的輸入框沒有值,那個按鈕就disabled狀態~~~ ...
  • 橋接模式 1.在系統沿著多個維度變化的同時,又不增加其複雜度並以達到解耦 2.最主要特點:將實現層(如元素綁定的事件)與抽象層(如修飾頁面UI邏輯)解耦分離,使兩部分獨立變化 3.避免需求的改變造成對象內部的修改,體現了面向對象對拓展的開發及修改的關閉原則 demo實例:創建一個對象橋接method ...
  • 接下來是apply的用法與理解 代碼大多是網上找的資料,然後自己隨手做了一下小改動,測試通過,便於自己理解-w- 便於理解的格式: 父類.call(子類); 父類.apply(子類,arguments); 和C#相反: class 子類 : 父類 { ... } ...
  • dataset--自定義屬性 HTMLElement.dataset data-*屬性集 元素上保存數據 liujl div.dataset. 屬性名 值 id “123456” accountName “liujl” name “劉江龍” email “[email protected]” mobi... ...
  • ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...