Jekyll 开源项目教程

Jekyll 开源项目教程

jekyll项目地址:https://gitcode.com/gh_mirrors/jek/jekyll

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

Jekyll 项目的目录结构通常包含以下几个主要部分：

• _config.yml: 存储配置数据。
• _drafts: 未发布的草稿文章。
• _includes: 可以重复使用的代码片段。
• _layouts: 页面布局模板。
• _posts: 已发布的文章。
• _data: 格式化的站点数据。
• _site: Jekyll 生成的最终站点。
• index.html: 主页或入口文件。

目录结构示例

jekyll-project/
├── _config.yml
├── _drafts/
│   ├── draft1.md
│   └── draft2.txt
├── _includes/
│   ├── header.html
│   └── footer.html
├── _layouts/
│   ├── default.html
│   └── post.html
├── _posts/
│   ├── 2021-01-01-title1.md
│   └── 2021-01-02-title2.md
├── _data/
│   └── members.yml
├── _site/
├── .gitignore
├── index.html
└── about.html

2. 项目的启动文件介绍

Jekyll 项目的启动文件通常是 index.html 或 index.md。这个文件是站点的入口点，负责展示主页内容。

index.html 示例

---
layout: default
title: 主页
---
<div class="home">
  <h1>欢迎来到我的博客</h1>
  <p>这里是我的个人博客，欢迎阅读我的文章。</p>
</div>

3. 项目的配置文件介绍

Jekyll 的配置文件是 _config.yml，它包含了站点的所有配置信息。

_config.yml 示例

title: 我的博客
email: example@example.com
description: >- # 这是对站点的描述
  欢迎来到我的博客，这里分享我的技术文章和生活点滴。
baseurl: "" # 站点的基础 URL
url: "http://example.com" # 站点的 URL
twitter_username: jekyllrb
github_username:  jekyll

# 构建设置
markdown: kramdown
theme: minima
plugins:
  - jekyll-feed

通过修改 _config.yml 文件，可以自定义站点的标题、描述、URL 等基本信息，以及选择主题和插件。

---

以上是 Jekyll 开源项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Jekyll 项目。

jekyll项目地址:https://gitcode.com/gh_mirrors/jek/jekyll