Google Code Prettify 教程
1. 项目介绍
Google Code Prettify 是一个轻量级的JavaScript库,主要用于HTML页面中源代码片段的美化。它能够自动识别并格式化多种编程语言的代码,使代码在网页中看起来更整洁,阅读体验更佳。此项目由Google开发并维护,但现在已被存档。
2. 项目快速启动
要在你的网站上使用Google Code Prettify,你需要执行以下步骤:
-
引入库:首先,在你的HTML文件中添加对预格式化脚本的引用。这通常在
<head>
标签内完成:<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/prettify.min.css"> <script src="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/run_prettify.min.js"></script>
-
标记代码片段:将你的代码包裹在
<pre class="prettyprint">
或<code class="prettyprint">
标签内,如下所示:<pre class="prettyprint"> // 示例代码 int main() { printf("Hello, World!"); return 0; } </pre>
-
运行Prettify:当浏览器加载到这个
<script>
时,它会自动格式化所有prettyprint
类的代码块。
3. 应用案例和最佳实践
-
自定义样式:你可以通过覆盖默认的CSS样式来自定义代码高亮的颜色和风格。
-
行号显示:要给每行都显示行号,可以使用下面的CSS样式:
<style> li.L0, li.L1, li.L2, li.L3, li.L5, li.L6, li.L7, li.L8 {list-style-type: decimal !important} </style>
-
多语言支持:Prettify 支持包括C、Java、Python等在内的多种语言,你可以通过CSS类指定特定语言,如
<pre class="prettyprint lang-java">
来指定Java代码。
4. 典型生态项目
Google Code Prettify被广泛应用于博客平台、代码分享网站和个人网页,以提高代码的可读性。虽然现在项目已不再积极维护,但其基本功能仍被其他一些现代化的代码高亮库所借鉴,例如Prism.js和Highlight.js。
示例生态项目
- Stack Overflow:问答社区中的代码段使用类似技术进行美化。
- GitHub Gist:GitHub上的Gist也提供了类似的功能,尽管不是直接使用Google Code Prettify。
请注意,由于Google Code Prettify已经被存档,可能不会有新的功能更新和修复,但它仍然可以在许多现有项目中正常工作。如果你寻求更现代且活跃维护的解决方案,建议考虑上述提到的替代库。