Pygments.CSS 教程
1. 项目介绍
Pygments.CSS 是一个仓库,它包含了 Pygments 的内置样式预编译成 CSS 文件。Pygments 是一个用于语法高亮的库,广泛用于博客、文档和代码分享平台。这个项目旨在简化将 Pygments 样式集成到你的网站或应用中的过程。
2. 项目快速启动
安装 Pygments
首先确保你已经安装了 Pygments。如果没有,可以通过 pip 进行安装:
pip install pygments
生成 CSS 文件
要从 Pygments 的内置样式创建 CSS 文件,你需要在命令行中运行 pygmentize
命令。例如,要生成默认样式的 CSS 文件,可以执行以下操作:
pygmentize -S default -f html -a highlight > default.css
这将会创建一个名为 default.css
的文件,其中包含了 CSS 类以进行代码高亮。
使用 CSS 文件
在 HTML 中,引入生成的 CSS 文件并设置代码块类,以便应用样式。例如:
<!DOCTYPE html>
<html lang="zh">
<head>
<meta charset="UTF-8">
<title>Pygments 高亮示例</title>
<link rel="stylesheet" href="path/to/default.css">
</head>
<body>
<pre><code class="language-python hljs">print("你好,世界!")</code></pre>
</body>
</html>
3. 应用案例和最佳实践
- Jekyll 博客:在 Jekyll 博客中,可以配置 Pygments 生成 CSS 并在
_includes
目录下添加自定义模板来应用高亮样式。 - Markdown 编辑器:对于支持自定义 CSS 的 Markdown 编辑器或转换工具(如 Pandoc),可以使用这些 CSS 文件来美化代码块。
- GitHub Pages:如果你的个人站点托管在 GitHub Pages 上,可以利用 GitHub Actions 自动构建过程生成并部署 CSS 文件。
最佳实践是定期更新 Pygments 和相应的 CSS 文件,以保持最新的语言支持和样式改进。
4. 典型生态项目
- Pelican:Pelican 是一个静态网站生成器,支持 Pygments 作为其内置的代码高亮插件。
- Jupyter Notebook:通过调用 Pygments API,可以在 Jupyter 笔记本中自定义代码片段的样式。
- ReStructuredText:在 Sphinx 文档构建过程中,可以使用 Pygments 进行代码高亮。
希望这篇教程帮助你更好地理解和使用 Pygments.CSS。了解更多详情,可直接访问项目仓库 richleland/pygments-css 查看完整的 README 文件和示例。