Jekyll Compress HTML 项目教程

2024-09-28 08:20:48作者：幸俭卉

1. 项目的目录结构及介绍

jekyll-compress-html/
├── .github/
│   └── workflows/
│       └── performance.yml
├── _layouts/
│   └── compress.html
├── _site/
├── src/
│   ├── compress.html
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── Gemfile
├── ISSUE_TEMPLATE.md
├── LICENSE
├── README.md
└── Rakefile

目录结构介绍

.github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和性能优化。
_layouts/: 存放 Jekyll 布局文件，compress.html 是压缩 HTML 的主要布局文件。
_site/: Jekyll 生成的静态站点文件夹，通常在开发过程中不会手动修改。
src/: 源代码文件夹，包含 compress.html 文件和其他相关文件。
test/: 测试文件夹，包含项目的测试代码。
.gitignore: Git 忽略文件，指定哪些文件和文件夹不需要被 Git 跟踪。
Gemfile: 定义项目所需的 Ruby 依赖包。
ISSUE_TEMPLATE.md: GitHub Issue 模板文件，用于规范化问题报告。
LICENSE: 项目许可证文件，本项目使用 MIT 许可证。
README.md: 项目说明文件，包含项目的概述、安装和使用说明。
Rakefile: Rake 任务文件，用于自动化执行一些常见的任务。

2. 项目的启动文件介绍

项目的启动文件主要是 _layouts/compress.html，它是 Jekyll 布局文件，用于压缩 HTML 输出。以下是该文件的简要介绍：

---
layout: compress
---
<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>Compressed HTML</title>
</head>
<body>
  {{ content }}
</body>
</html>

启动文件介绍

layout: compress: 指定使用 compress 布局。
{{ content }}: 插入页面的内容，Jekyll 会自动处理并压缩这部分内容。

3. 项目的配置文件介绍

项目的配置文件主要是 _config.yml，但在这个项目中，主要的配置是通过 _layouts/compress.html 文件中的 Front Matter 来实现的。以下是一个示例配置：

# _config.yml
compress_html:
  clippings: all
  comments: ["<!--", "-->"]
  endings: all
  startings: all

配置文件介绍

compress_html: 压缩 HTML 的配置项。
- clippings: 指定要移除的剪辑内容。
- comments: 指定要移除的注释内容。
- endings: 指定要移除的结束标签。
- startings: 指定要移除的开始标签。

通过这些配置，可以灵活地控制 HTML 压缩的行为，以适应不同的需求。

登录后查看全文