前端:给你的Markdown文章添加代码高亮及行号

文 / 秦未

这篇文章是给不使用Pygments的童鞋写的,前端的插件实在太多,除了学习外,在快速开发时重复造轮子没有必要,现在就教大家快速实现代码块的代码高亮及行号。

先贴效果:

Python代码块

要使用的插件:

highlightj.js 代码高亮
highlightjs-line-numbers.js 代码行号


highlightj.js 优势:
  • 支持174种语言和拥有77种款式
  • 自动语言检测
  • 多语言代码突出显示
  • 可用于node.js
  • 与任何标记一起使用
  • 兼容任何js框架

一、使用方法:

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

自己挑选自己喜欢的就好。

1.在需要渲染的页面引入样式文件:
<link href="https://cdn.bootcss.com/highlight.js/9.6.0/styles/atelier-lakeside-dark.min.css" rel="stylesheet"/>
2.引入Js文件并添加调用命令:
<script src="//cdn.bootcss.com/highlight.js/9.11.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
3.添加行号插件:
<script src="//cdn.bootcss.com/highlightjs-line-numbers.js/1.1.0/highlightjs-line-numbers.min.js"></script>
<script>hljs.initLineNumbersOnLoad();</script>

---以下部分为2017.06.09新增内容---

最后涉及一点关于Markdown解析模块的优化方案:

经过了解,目前最好的Markdown解析模块是Mistune,它相对于Markdown模块,文本渲染速度提升了十倍左右,而且使用也非常简单,我们没什么理由拒绝使用它。

关于使用教程,GitHub已经介绍得很清楚了,但是由于是英文的,我就粗略的翻译一下,给大家介绍一下使用方法。


安装:

pip install mistune

或者用cython编译它,显然速度更快:

pip install cython mistune

基础的使用:

import mistune

mistune.markdown('I am using **mistune markdown parser**')
# 输出结果: <p>I am using <strong>mistune markdown parser</strong></p>

当然,官方推荐使用下面这种方法,能提高性能:

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为要渲染的文本内容

说明:

  • escape:如果设置为False,则所有原始HTML标签都不会被转义。
  • hard_wrap:如果设置为True,它将具有GFM换行符功能。 所有新行将被替换为<br />标记。
  • use_xhtml:如果设置为True,则所有标签都将位于xhtml中,例如:<hr />标签。
  • parse_block_html:仅在块级别HTML中解析文本。
  • parse_inline_html:仅在内联级HTML中解析文本。

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

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

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

更多内容,请查阅官方文档:http://mistune.readthedocs.io/en/latest/


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

推荐阅读更多精彩内容

  • 简介浏览器可以被认为是使用最广泛的软件,本文将介绍浏览器的工 作原理,我们将看到,从你在地址栏输入google.c...
    听风阁阅读 3,270评论 0 7
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,016评论 4 62
  • 教程http://baijiahao.baidu.com/s?id=1564143812832780&wfr=sp...
    geaosu阅读 294评论 0 0
  • 最早见到夹克是是大二还是大三的时候,一只折耳的英短,就这么小,直到后来它长得这么大了,我对它的印象始终停留在那只小...
    崔莽子阅读 217评论 0 1
  • 我不知道现在的自己为什么会压抑的很难受,有时候明明觉得自己是那种无所谓,遇到什么事都能乐观地坦然面对。可是有时候自...
    若温言或软语阅读 294评论 0 0