Jekyll Boilerplate 教程

Jekyll Boilerplate 教程

jekyll-boilerplateA cleaned up version of the initial Jekyll setup for quick use.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-boilerplate

本教程旨在指导您快速了解并使用 KittyGiraudel 的 Jekyll Boilerplate，这是一个强大的Jekyll基础模板，专为简化博客或静态网站搭建而设计。

1. 项目目录结构及介绍

项目遵循Jekyll的标准约定，但通过一些自定义来提升开发体验。下面是其主要目录结构及其简要说明：

.
├── _includes         # 包含所有可复用的部分如页眉、页脚。
├── _layouts           # 布局文件，控制页面的整体结构。
├── _posts             # 存放Markdown格式的文章。
├── assets             # 静态资源，如CSS、JavaScript等。
│   ├── css
│   └── js
├── about.md           # 示例页面，通常用于“关于”页面。
├── index.html         # 主页入口。
└── config.yml         # Jekyll的配置文件。

• _includes 目录中的文件可以被其他页面嵌入以实现代码重用。
• _layouts 中的布局决定了内容的外观，您可以在此定制页面的结构。
• _posts 是存放您撰写的文章的地方，采用特定日期-标题格式命名的Markdown文件。
• assets 用于管理前端资源，包括样式表（CSS）和脚本（JS）。
• config.yml 是核心配置文件，允许您调整站点设置。

2. 项目的启动文件介绍

项目的核心启动逻辑主要依赖于Jekyll自身的工作机制，无需单独的启动文件。然而，当您首次运行项目时，重点在于Gemfile和_config.yml文件。

• Gemfile: 定义了项目所需的Ruby gem依赖，例如Jekyll和其他可能的插件，确保环境的一致性。

• _config.yml: 实际的配置文件，它允许您设置站点元数据如标题、作者、URL等，以及启用或禁用某些Jekyll特性。是定制化您的Jekyll站点的关键所在。

启动项目前，通过命令行执行bundle install以安装必要的gem，然后使用bundle exec jekyll serve来启动本地服务器查看你的站点。

3. 项目的配置文件介绍

_config.yml 文件是Jekyll中最重要的配置文件，下面是几个关键配置项的例子及其解释：

title: 我的博客                     # 站点标题
author: [您的名字]                 # 作者名
timezone: Asia/Shanghai            # 设置时区
url: "http://yourblog.com"        # 生产环境下的站点URL
sass:                             # Sass编译配置
  style: compressed               # 输出风格：nested, expanded, compact, compressed
exclude: ['README.md', 'Gemfile', 'Gemfile.lock'] # 构建时排除的文件

• title 和 author 明确了站点的基本身份。
• timezone 确保时间戳正确处理，尤其在多作者环境中尤为重要。
• url 在生成绝对链接时非常关键，尤其是在生产环境中。
• sass.style 设置了Sass文件编译后的样式压缩级别，对于生产部署很有帮助。
• exclude 列表避免了一些不应被编译成站点内容的开发文件被包含进去。

通过修改这些配置项，您可以轻松地个性化您的Jekyll网站，使其符合您的需求。记得每次更改配置后重启Jekyll服务以应用更新。

jekyll-boilerplateA cleaned up version of the initial Jekyll setup for quick use.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-boilerplate