网页代码高亮插件真的是非常多。例如:SyntaxHighlighter
,Google Code Prettify
,Highlight.js
等等。
今天介绍一个漂亮而且小巧的JS插件:Prism.js
官网地址:http://prismjs.com/index.html
原文链接:http://weiya.me/item/65.html
为什么选用Prism.js?
除了简单,小巧之外,还有以下优点
极致易用:引用 prism.css 和 prism.js,使用合适的 HTML5 标签(code.language-xxxx),搞定!
天生伶俐:语言的 CSS 类是可继承的,所以你只需定义一次就能应用到多个代码片段。
轻如鸿毛:代码压缩后只有 1.6KB。每添加一个语言平均增加 0.3-0.5KB,主题在 1KB 左右。
快如闪电:如果可能,支持通过 Web Workers 实现并行。
轻松扩展:定义新语言或扩展现有语法,或者新增功能都非常简单。
丰富样式:所有的样式通过 CSS 完成,并使用合理的类名如:.comment, .string, .property 等。
谁在使用
我们截取一些官方公布的使用者,这里不乏一些十分大的网站。
示例
本文博客就是使用的Prism.js
,我们直接来一段代码示例
HTML:
...
...
CSS:
.container .content .copy-link{
border:1px solid #E5E5E5;
background:#f9f9f9;
padding:15px 15px 15px 120px;
margin-bottom:30px;
position: relative;
margin-top:90px;
}
PHP:
public function init()
{
parent::init(); // TODO: Change the autogenerated stub
if(Yii::$app->user->id)
{
$this->redirect(Url::home());
}
}
当然,不止这么多。Prism.js
还支持其他上百种的编程语言。
其他主题
本博客使用的是Prism.js
的默认主题,另外其还支持很多种主题。
Dark:
Funky
Okaidia
Twilight
Coy
Solarized light
下载
Prism.js
支持很多种语言和插件主题。把一些不必要支持的语言包下载下来,会加大库文件大小,拖累我们网站加载速度。所以Prism.js
采用自定义下载。
从这里可以看出Prism.js
支持的配置项还是非常多的。我们勾选上我们需要的选项,点击最下方的下载css
和js
下载文件。
提示: 除了选择语言,在最下方的Plugins
选项中,有一个Line Numbers
还是非常值得下载的,可以在代码前显示行号。
使用
使用非常简单,首先引入刚刚下载好的2个文件。
...
...
页面上只要遇到类似下面的代码,就会被高亮。
p { color: red }
但是,并不是所有的后台编辑器都会直接产生类似这样的代码。
下面看两种常用编辑器产生的代码相关HTML
。
Markdown
首先来看常用markdown
编辑器,如果遇到代码编辑,他们会产生如下的HTML
代码:
class GrabImage{
}
完全符合要求,所以只需要在markdown
编辑代码的时候选择语言就没有问题。
Ueditor
再来看市面上使用非常广泛的百度Ueditor
编辑器,后台代码编辑会产生如下的HTML
代码
<link rel="icon" href="">
并没有产生预期的效果,而是只生成和一个
class="brush:html;toolbar:false"
。这个class
可是不一般,其中brush:html
中的html
就代表的是HTML
标签。如果在后台我们选择代码语言为java
,那么这里会显示brush:java
。所以,我们只要获取语言名称就可以构造符合要求的高亮代码。
这里我们只使用JS
构造高亮代码,如果使用后台语言来构造不做研究。
$(document).ready(function(){
var doc_pre = $("#post_content pre");
doc_pre.each(function(){
var class_val = $(this).attr('class');
var class_arr = new Array();
class_arr = class_val.split(';');
class_arr = class_arr['0'].split(':');
var lan_class = 'language-'+class_arr['1'];
var pre_content = ''+$(this).html()+'
';
$(this).html(pre_content);
});
});
阐述下逻辑:
首先遍历所有的
标签,获取其
class
属性值。使用
;
号来分隔值,放入数组。再次获取数组第一个值,再次使用
:
分隔,放入数组。数组内第二个值即为html
(代码语种)获取
标签内容,放入
包裹起来,再次放入
标签。
随便找了个示例看下:
<link
rel
=
"icon
"
href
=
"
"
>
添加行号
需要实现行号效果,只需要在标签中加上
line-numbers
类即可。在之前的js
代码中添加一行。
提示:要记得你下载了Line Numbers插件
$(this).attr("class",'line-numbers '+lan_class);
实现效果:
完整代码:
$(document).ready(function(){
var doc_pre = $("#post_content pre");
doc_pre.each(function(){
var class_val = $(this).attr('class');
var class_arr = new Array();
class_arr = class_val.split(';');
class_arr = class_arr['0'].split(':');
var lan_class = 'language-'+class_arr['1'];
var pre_content = ''+$(this).html()+'
';
$(this).html(pre_content);
$(this).attr("class",'line-numbers '+lan_class);
});
});