代码着色之SyntaxHighlighter项目(最流行的代码高亮)

 更新时间:2014年04月29日 22:15:11   转载 作者:  
dp.SyntaxHighlighter。它可以在网页中对各种程序源代码语法进行加亮显示。支持当前流 行的各种编程语言:C#、CSS、C++、Delphi、Java、JavaScript、PHP、Python、Ruby、SQL、Visual Basic、XML / HTML等

下载地址:http://www.dreamprojections.com/syntaxhighlighter/
                或http://code.google.com/p/syntaxhighlighter/
演示地址:http://www.dreamprojections.com/syntaxhighlighter/Tests/PHP.html

使用方法:

1、假设网页文件test.htm存放在一个目录,则将dp.SyntaxHighlighter解压缩到该目录下的子目录,假设为images
2、在网页的<head></head>之间插入以下代码:

<link type="text/css" rel="stylesheet" href="images/Styles/SyntaxHighlighter.css"></link>

3、在网页要显示程序源代码的地方插入以下代码(其中的class="js"表示以js语法显示源代码,其他可设定的class值分别为c#、css、c、delphi、java、js、php、python、ruby、sql、vb、xml):

复制代码 代码如下:

<textarea name="code" class="js" rows="15" cols="100">
程序源代码放在这儿
</textarea>

4、在网页尾部的</body>之前插入以下代码:

复制代码 代码如下:

<html>
<head>
<title>测试</title>
<link type="text/css" rel="stylesheet" href="Styles/SyntaxHighlighter.css"></link>
</head>
<body>
<textarea name="code" class="java" rows="15" cols="100">
public class a{
}
</textarea>
</body>
<script class="javascript" src="Scripts/shCore.js"></script>
<script class="javascript" src="Scripts/shBrushCSharp.js"></script>
<script class="javascript" src="Scripts/shBrushPhp.js"></script>
<script class="javascript" src="Scripts/shBrushJScript.js"></script>
<script class="javascript" src="Scripts/shBrushJava.js"></script>
<script class="javascript" src="Scripts/shBrushVb.js"></script>
<script class="javascript" src="Scripts/shBrushSql.js"></script>
<script class="javascript" src="Scripts/shBrushXml.js"></script>
<script class="javascript" src="Scripts/shBrushDelphi.js"></script>
<script class="javascript" src="Scripts/shBrushPython.js"></script>
<script class="javascript" src="Scripts/shBrushRuby.js"></script>
<script class="javascript" src="Scripts/shBrushCss.js"></script>
<script class="javascript" src="Scripts/shBrushCpp.js"></script>
<script class="javascript">
dp.SyntaxHighlighter.ClipboardSwf ='Scripts/clipboard.swf';
dp.SyntaxHighlighter.HighlightAll('code');
</script> 
</html>


SyntaxHighlighter 是Google Code 上的一个开源项目,主要用于给网页上的代码着色,使用十分方便,效果也不错,而且几乎支持常见的所有语言。

安装使用方法:

1. 首先在页面上添加如下代码(假设下载后的SyntaxHighlighter放在SyntaxHighlighter目录下面,注意目录结构):

复制代码 代码如下:

<link type="text/css" rel="stylesheet" href="SyntaxHighlighter/Styles/SyntaxHighlighter.css"></link>
<script language="javascript" src="SyntaxHighlighter/Scripts/shCore.js"></script>
<script language="javascript" src="SyntaxHighlighter/Scripts/shBrushCSharp.js"></script>
<script language="javascript" src="SyntaxHighlighter/Scripts/shBrushXml.js"></script>
<script language="javascript">
window.onload = function ()
{
    dp.SyntaxHighlighter.ClipboardSwf = 'SyntaxHighlighter/Scripts/clipboard.swf';
    dp.SyntaxHighlighter.HighlightAll('code');
}
</script>

官方的安装中没有window.onload,我想这个还是需要的,毕竟,页面加载的时候我就需要给代码着色。

2. 使用方法如下:

方法一:使用pre

复制代码 代码如下:

<pre name="code" class="c-sharp">
... some code here ...
</pre>

方法二:使用textarea

复制代码 代码如下:

<textarea name="code" class="c#" cols="60" rows="10">
... some code here ...
</textarea>

另外,这里还有一些高级特性的设置方法可供参考,诸如代码折叠等。

我在互动wiki 上安装成功,安装方法如上,第一步的修改代码放到doc.php文件的最后即可,以后编辑wiki的时候直接使用html模式即可按照第二步的方法给代码着色。

PS:CSDN的blog系统上使用的也是这个插件:>

=============================
http://code.google.com/p/syntaxhighlighter/downloads/list

第一步:增加样式包含

<link type=”text/css” rel=”stylesheet” href=”Styles/SyntaxHighlighter.css”></link>

第二步:增加代码

复制代码 代码如下:

<textarea name=”code” class=”php”>
代码放在这里
</textarea>

这里的class指的是语言有c,c#,vb,java,php,ruby,js,css,sql…

第三步包含所需要的js

复制代码 代码如下:

<script language=”javascript” src=”Scripts/shCore.js”></script>
<script language=”javascript” src=”Scripts/shBrushPhp.js”></script>(包含对应语言的文件)
<script language=”javascript”>
dp.SyntaxHighlighter.ClipboardSwf = ‘Scripts/clipboard.swf';// 复制代码要用到
dp.SyntaxHighlighter.HighlightAll('code');// 这里对应的就是上面的name
</script>

====================================

1.首先下载SyntaxHighlighter.

2.解压到SyntaxHighlighter目录中.

3.建立HTML文件:

复制代码 代码如下:

<pre name="code" class="Ruby">
...Ruby代码...
</pre>

可以应用在pre和textarea两种HTML标签内,name为code,class为要着色的语言,现在支持C, C#, CSS, Delphi, Java, JScript, Php, Python, Ruby, Sql, VB, XML这些语言.

4.加入所需的CSS和JS文件:

复制代码 代码如下:

<link rel="stylesheet" type="text/css" href="./lib/SyntaxHighlighter/Styles/SyntaxHighlighter.css" />
<script src="./lib/SyntaxHighlighter/Scripts/shCore.js"></script>
<script src="./lib/SyntaxHighlighter/Scripts/shBrushRuby.js"></script>

这里只用了Ruby,其他的类似.

5.接下来就是在window的onload事件内,让SyntaxHighlighter工作起来.

复制代码 代码如下:

window.onload = function()

{
    dp.SyntaxHighlighter.ClipboardSwf = './lib/SyntaxHighlighter/Scripts/clipboard.swf';
    dp.SyntaxHighlighter.HighlightAll("code");
};

之后,刷新下页面,你就会发现,代码已经被着上了相应的颜色了

======================
将你要高亮显示的代码放在 pre 或 textarea 中

复制代码 代码如下:

<pre name="code" class="c-sharp">
... some code here ...
</pre>
<textarea name="code" class="c#" cols="60" rows="10">
... some code here ...
</textarea>

class选项允许你单独配置文本块。

nogutter     将不会显示行号。

nocontrols     将不会在顶部显示控制器。
collapse     将默认折叠代码。
firstline[value]     行计数开始值。默认值是 1
showcolumns     将在第一行显示行列。

这些选项和别名放置在一起,使用冒号 : 字符分隔。

复制代码 代码如下:

<pre name="code" class="html:nocontrols:firstline[10]">

... some code here ...
</pre>

语言     别名

C++     cpp, c, c++
C#     c#, c-sharp, csharp
CSS     css
Delphi     delphi, pascal
Java     java
Java Script     js, jscript, javascript
PHP     php
Python     py, python
Ruby     rb, ruby, rails, ror
Sql     sql
VB     vb, vb.net
XML/HTML     xml, html, xhtml, xslt

在页面最后添加JS和CSS引用    JS有很多,若是语言固定的话,只要引入 shCore 和 shBrushXml(相应) 的JS文件就行了

复制代码 代码如下:

<link type="text/css" rel="stylesheet" href="css/SyntaxHighlighter.css"></link>
<script language="javascript" src="js/shCore.js"></script>
<script language="javascript" src="js/shBrushCSharp.js"></script>
<script language="javascript" src="js/shBrushXml.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.ClipboardSwf = '/flash/clipboard.swf';
dp.SyntaxHighlighter.HighlightAll('code');//这里的 ‘code' 为上面放置代码的容器
</script>

    * SyntaxHighlighter-HighlightAll 方法

这是一个全局函数,它找出网页上所有的代码块,将他们转换成高亮的代码块。
参数
function dp.SyntaxHighlighter.HighlightAll(name, [showGutter], [showControls],
[collapseAll], [firstLine], [showColumns])
 

name         必要     <pre> 和 <textarea> 元素使用的名称。

showGutter     可选     打开或关闭所有处理的代码块的行号。(默认为 true)
showControls     可选     打开或关闭所有处理的 <pre> 的控制器。(默认为 true)
collapseAll     可选     打开或关闭所有处理的 <pre> 的折叠。如果 showControls 是 false 或被交换了,这个值将被忽略。(默认为 false)
firstLine     可选     允许指定行号开始的第一行。当你想指明代码块在文件的哪个相对位置时有用。(默认为 1)
showColumns     可选     将在第一行显示行列。(默认为 false)
 

所有传到 HighlightAll 调用的值将重载配置的对应选项.

下载地址:

http://code.google.com/p/syntaxhighlighter/


附一个小例子说一下 textarea 和 pre 的区别

复制代码 代码如下:

<html>
<head>
<title>高亮测试</title>
    <link type="text/css" rel="stylesheet" href="Styles/SyntaxHighlighter.css"/>
    <script language="javascript" src="Scripts/shCore.js"></script>
    <script language="javascript" src="Scripts/shBrushXml.js"></script>
</head>
<body>
<textarea name="code" class="xml" rows="15" cols="100">
程序源代码放在这儿afds
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
请注译掉这二句查看效果,注意 textarea 和 pre 的分别。pre中的 《 号需要转译,要不然就原样输出了,在高亮代码没有生效的情况下。
<h1>adsfadfadf</h1>
    -------------------
&lt;h1>adsfadfadf&lt;/h1>
</textarea>
<pre name="code2" class="xml" rows="15" cols="100">
程序源代码放在这儿afds
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
    <h1>adsfadfadf</h1>
    -------------------
&lt;h1>adsfadfadf&lt;/h1>
</pre>
<script class="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
</script>
</body>
</html>

相关文章

  • Git 教程之远程仓库详解

    Git 教程之远程仓库详解

    本文主要介绍Git 远程仓库的知识,这里整理了相关资料,及命令详解,图文并茂的介绍该部分内容,有需要的小伙伴可以参考下
    2016-09-09
  • Git 的基本操作、开发流程、实用技巧总结(陈彦贝)

    Git 的基本操作、开发流程、实用技巧总结(陈彦贝)

    这篇文章主要介绍了Git 的基本操作、开发流程、实用技巧总结,需要的朋友可以参考下
    2017-09-09
  • WebSocket部署到服务器出现连接失败问题的分析与解决

    WebSocket部署到服务器出现连接失败问题的分析与解决

    这篇文章主要给大家介绍了关于WebSocket部署到服务器出现连接失败问题的分析与解决方法,文中给出了详细的介绍供大家参考学习,文末也给出了demo下载地址,需要的朋友们可以下载学习,下面随着小编来一起学习学习吧。
    2017-10-10
  • VSCode常用知识小结

    VSCode常用知识小结

    本文给大家汇总介绍了vscode的下载,安装,常用插件以及常用的快捷键,非常的详细,希望对大家使用vscode能够有所帮助
    2020-02-02
  • fiddler使用方法之Fiddler显示IP,Fiddler中文乱码解决方法以及fiddler模拟发送get/post请求

    fiddler使用方法之Fiddler显示IP,Fiddler中文乱码解决方法以及fi

    今天为大家介绍fiddler的3种使用技巧,(1)Fiddler抓包显示域名IP(2)解决Fiddler抓包时中文乱码问题(3)利用fiddler模拟发送get/post请求的方法
    2018-10-10
  • http协议详解(超详细)

    http协议详解(超详细)

    HTTP协议(HyperText Transfer Protocol,超文本传输协议)是用于从WWW服务器传输超文本到本地浏览器的传送协议。
    2011-08-08
  • 提高编程技能的11个建议

    提高编程技能的11个建议

    当你不熟悉编程的时候,你可能会觉得无从下手,并且不知道如何运用学到的知识。只要你通过了这一困难的学习阶段,你就会发现一个全新的世界
    2014-08-08
  • 漂流瓶推送需求的逻辑实现代码

    漂流瓶推送需求的逻辑实现代码

    假想有一个瓶子池,当点击附近标签的时候要从池里面推送一个瓶子给用户.推送按照一定的逻辑对池里的瓶子排序,排序规则主要由两个数据决定:瓶子上次推送时间和与用户之间的距离.
    2010-12-12
  • 算法系列15天速成 第十四天 图【上】

    算法系列15天速成 第十四天 图【上】

    越是复杂的东西越能体现我们码农的核心竞争力,既然要学习图,得要遵守一下图的游戏规则
    2013-11-11
  • TCP协议详解_动力节点Java学院整理

    TCP协议详解_动力节点Java学院整理

    本文描述了TCP协议,首先简单介绍了TCP完成了一些什么功能;介绍了TCP报文格式,以及典型报文的数据格式。现在通过本文给大家详细介绍,感兴趣的的朋友一起看看吧
    2017-07-07

最新评论