Jekyll Foundation 项目教程
1. 项目的目录结构及介绍
Jekyll Foundation 项目的目录结构如下:
jekyll-foundation/
├── _config.yml
├── _data/
├── _includes/
├── _layouts/
├── _posts/
├── _sass/
├── assets/
├── index.html
├── Gemfile
├── Gemfile.lock
└── README.md
目录结构介绍:
- _config.yml: 项目的配置文件,包含 Jekyll 站点的全局配置。
- _data/: 存放自定义数据文件,如 YAML、JSON 或 CSV 文件,可以在模板中使用。
- _includes/: 存放可重用的 HTML 片段,可以在多个页面中包含。
- _layouts/: 存放页面布局模板,定义页面的基本结构。
- _posts/: 存放博客文章,文件名格式为
YYYY-MM-DD-title.md
。 - _sass/: 存放 SASS 文件,用于定义站点的样式。
- assets/: 存放静态资源文件,如图片、CSS、JavaScript 等。
- index.html: 站点的首页文件。
- Gemfile: 定义项目所需的 Ruby 依赖。
- Gemfile.lock: 锁定 Gemfile 中定义的依赖版本。
- README.md: 项目的说明文档。
2. 项目的启动文件介绍
Jekyll Foundation 项目的启动文件是 index.html
。这个文件是站点的首页,通常包含站点的基本结构和内容。
index.html 文件内容示例:
---
layout: default
title: Home
---
<h1>Welcome to Jekyll Foundation</h1>
<p>This is the homepage of your Jekyll site.</p>
启动文件介绍:
- layout: 指定使用的布局模板,这里是
default
。 - title: 页面的标题,会在浏览器标签中显示。
- 内容: 页面的主要内容,通常是 HTML 代码。
3. 项目的配置文件介绍
Jekyll Foundation 项目的配置文件是 _config.yml
。这个文件包含了 Jekyll 站点的全局配置,如站点名称、描述、URL、作者信息等。
_config.yml 文件内容示例:
title: Jekyll Foundation
description: A Jekyll site using Foundation framework.
url: "https://example.com"
author:
name: "Your Name"
email: "your.email@example.com"
markdown: kramdown
theme: minima
plugins:
- jekyll-feed
- jekyll-seo-tag
配置文件介绍:
- title: 站点的标题。
- description: 站点的描述。
- url: 站点的 URL。
- author: 作者信息,包括姓名和邮箱。
- markdown: 使用的 Markdown 解析器,这里是
kramdown
。 - theme: 使用的主题,这里是
minima
。 - plugins: 使用的 Jekyll 插件,如
jekyll-feed
和jekyll-seo-tag
。
通过以上配置,Jekyll 站点可以生成符合需求的静态网站。