前端:給你的Markdown文章添加代碼高亮及行號

文 / 秦未

這篇文章是給不使用Pygments的童鞋寫的,前端的插件實在太多,除了學(xué)習(xí)外,在快速開發(fā)時重復(fù)造輪子沒有必要,現(xiàn)在就教大家快速實現(xiàn)代碼塊的代碼高亮及行號。

先貼效果:

Python代碼塊

要使用的插件:

highlightj.js 代碼高亮
highlightjs-line-numbers.js 代碼行號


highlightj.js 優(yōu)勢:
  • 支持174種語言和擁有77種款式
  • 自動語言檢測
  • 多語言代碼突出顯示
  • 可用于node.js
  • 與任何標記一起使用
  • 兼容任何js框架

一、使用方法:

highlightj 樣式文件地址:http://www.bootcdn.cn/highlight.js/

自己挑選自己喜歡的就好。

1.在需要渲染的頁面引入樣式文件:
<link  rel="stylesheet"/>
2.引入Js文件并添加調(diào)用命令:
<script src="http://cdn.bootcss.com/highlight.js/9.11.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
3.添加行號插件:
<script src="http://cdn.bootcss.com/highlightjs-line-numbers.js/1.1.0/highlightjs-line-numbers.min.js"></script>
<script>hljs.initLineNumbersOnLoad();</script>

---以下部分為2017.06.09新增內(nèi)容---

最后涉及一點關(guān)于Markdown解析模塊的優(yōu)化方案:

經(jīng)過了解,目前最好的Markdown解析模塊是Mistune,它相對于Markdown模塊,文本渲染速度提升了十倍左右,而且使用也非常簡單,我們沒什么理由拒絕使用它。

關(guān)于使用教程,GitHub已經(jīng)介紹得很清楚了,但是由于是英文的,我就粗略的翻譯一下,給大家介紹一下使用方法。


安裝:

pip install mistune

或者用cython編譯它,顯然速度更快:

pip install cython mistune

基礎(chǔ)的使用:

import mistune

mistune.markdown('I am using **mistune markdown parser**')
# 輸出結(jié)果: <p>I am using <strong>mistune markdown parser</strong></p>

當(dāng)然,官方推薦使用下面這種方法,能提高性能:

import mistune

markdown = mistune.Markdown()
markdown('I am using **mistune markdown parser**')

Mistune默認啟用了所有功能, 你不必配置任何東西。 但是你可以選擇更改解析器的一些配置。

renderer = mistune.Renderer(escape=True, hard_wrap=True)
# 實例化mistune
markdown = mistune.Markdown(renderer=renderer)
markdown(text)
# text為要渲染的文本內(nèi)容

說明:

  • escape:如果設(shè)置為False,則所有原始HTML標簽都不會被轉(zhuǎn)義。
  • hard_wrap:如果設(shè)置為True,它將具有GFM換行符功能。 所有新行將被替換為<br />標記。
  • use_xhtml:如果設(shè)置為True,則所有標簽都將位于xhtml中,例如:<hr />標簽。
  • parse_block_html:僅在塊級別HTML中解析文本。
  • parse_inline_html:僅在內(nèi)聯(lián)級HTML中解析文本。

使用默認渲染器時,可以使用以下快捷方式之一:

# 第一種方式
mistune.markdown(text, escape=True, hard_wrap=True)

# 第二種方式
markdown = mistune.Markdown(escape=True, hard_wrap=True)
markdown(text)

更多內(nèi)容,請查閱官方文檔:http://mistune.readthedocs.io/en/latest/


最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,406評論 6 538
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,034評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,413評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,449評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 72,165評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,559評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,606評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,781評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,327評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,084評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,278評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,849評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,495評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,927評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,172評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,010評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 48,241評論 2 375

推薦閱讀更多精彩內(nèi)容