原名:SyntaxHighlighter,是一款用于web页面的代码着色工具,可以用来着色多种语言,可以是HTML,CSS,Javascript,还可以是C,JAVA等编程语言。最早见于Yahoo的YUI,当时还属于自由软件,最近打开官方网站发现已被goolge收编。
SyntaxHighlighter是一款强大的Web代码高亮插件,它能够为网页中的各种编程语言源代码提供美观的色彩渲染。这个工具最初在Yahoo的YUI库中出现,作为一个开源项目,但现在已经归Google所有。SyntaxHighlighter支持包括HTML、CSS、JavaScript以及C、JAVA等多种编程语言在内的代码着色。
要使用SyntaxHighlighter,首先你需要从官方指定的下载地址获取资源,比如http://www.dreamprojections.com/syntaxhighlighter/ 或 http://code.google.com/p/syntaxhighlighter/。下载后,你会得到包含Scripts和Styles两个文件夹的压缩包,这两个文件夹分别包含了JavaScript脚本和CSS样式文件。
集成SyntaxHighlighter到你的网页中,需要以下步骤:
1. 将Scripts和Styles文件夹放置在你的网页同一目录下,确保它们可以被正确引用。
2. 在网页的`<head>`部分添加引用SyntaxHighlighter的CSS文件,例如:
```html
<link type="text/css" rel="stylesheet" href="Styles/SyntaxHighlighter.css">
```
3. 在你希望显示代码的地方,使用`<textarea>`标签,指定`name="code"`和`class`属性来定义代码类型。例如,对于JavaScript代码,你可以这样写:
```html
<textarea name="code" class="js" rows="15" cols="100">
// 你的JavaScript代码
</textarea>
```
4. 在`</body>`标签之前,引入所有需要的JavaScript文件,这些文件对应你想要支持的代码语言。例如,如果你需要支持JavaScript、HTML和CSS,你需要引入:
```html
<script class="javascript" src="Scripts/shCore.js"></script>
<script class="javascript" src="Scripts/shBrushJScript.js"></script>
<script class="javascript" src="Scripts/shBrushXml.js"></script>
<script class="javascript" src="Scripts/shBrushCss.js"></script>
```
注意,shCore.js是基础核心文件,其他shBrush*.*.js文件用于特定语言的高亮。
5. 加入JavaScript代码来启动SyntaxHighlighter的高亮功能:
```html
<script class="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
</script>
```
此外,SyntaxHighlighter允许你在同一页面上使用多个代码块,只需重复上述步骤即可。为了实现更自定义的样式或功能,你还可以查阅官方文档,了解如何配置和扩展这个插件。
值得注意的是,SyntaxHighlighter还提供了预设的着色风格,可以根据个人喜好选择合适的样式。同时,由于它是基于JavaScript的,因此在用户的浏览器端执行,可能会影响到页面的加载速度,尤其是在包含大量代码的情况下。
SyntaxHighlighter是一个强大且易于使用的代码高亮工具,它通过简单的设置就能让网页中的代码更加清晰、易读,为开发者和读者提供了良好的阅读体验。