Prism.js 教程:语法高亮工具入门及实践
1. 项目介绍
Prism.js 是一个轻量级且易于使用的语法高亮库,适用于HTML5中的代码片段。它具有直观的语言类,核心文件只有2KB(已压缩并gzip),并且支持多种语言扩展,主题大约1KB。Prism.js 支持Web Worker进行并行处理,允许您自定义新的语言或扩展现有语言,以及利用其插件架构添加新功能。许多知名网站,如TYPO3 CMS、Angular和WordPress等都在使用Prism.js。
2. 项目快速启动
要开始使用Prism.js,只需将CSS和JavaScript文件引入到您的HTML页面中:
<!DOCTYPE html>
<html>
<head>
<link href="https://cdn.jsdelivr.net/npm/prismjs@latest/themes/prism.css" rel="stylesheet" />
</head>
<body>
<script src="https://cdn.jsdelivr.net/npm/prismjs@latest/components/prism-core.min.js"></script>
<!-- 引入你需要的语言组件,例如CSS -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@latest/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@latest/components/prism-css.min.js"></script>
</body>
</html>
接下来,用合适的HTML5代码标签(<code>
和 class="language-xxxx"
)标记你的代码片段:
<pre><code class="language-css">p {
color: red;
}</code></pre>
如果你想在页面加载完成后自动高亮所有代码块,可以在脚本中添加以下行:
document.addEventListener('DOMContentLoaded', function () {
Prism.highlightAll();
});
3. 应用案例和最佳实践
代码块标记
正确地包裹<code>
元素在<pre>
中可以提升语义化,并帮助Prism.js工作:
<pre><code class="language-javascript">
function hello(name) {
console.log(`Hello, ${name}!`);
}
hello("World");
</code></pre>
动态内容高亮
如果你的页面包含动态加载的代码块,可以使用Prism.highlightElement()
来单独高亮它们:
const newCodeBlock = document.querySelector('#new-code');
Prism.highlightElement(newCodeBlock);
4. 典型生态项目
除了Prism.js核心库之外,还有很多扩展和配套项目:
- Line Numbers Plugin: 显示代码行号。
- Autolinker Plugin: 自动链接URL。
- Copy Button Plugin: 添加复制代码按钮。
此外,社区还创建了各种语言扩展和教程,帮助在不同平台如WordPress、Blogger/BlogSpot上集成Prism.js。
以上就是对Prism.js的基本介绍和入门指南。为了获得更详细的文档和最新的更新,请访问Prism.js官网。祝你在代码高亮的路上一帆风顺!