Material Jekyll 主题使用教程
1. 项目的目录结构及介绍
Material Jekyll 主题的目录结构如下:
material-jekyll-theme/
├── _includes/ # 包含页面的部分内容
├── _layouts/ # 页面布局模板
├── _posts/ # 博客文章存放目录
├── _sass/ # SASS 样式文件
├── assets/ # 静态资源文件,如图片、CSS、JavaScript
├── _config.yml # 项目配置文件
├── about.md # 关于页面
├── index.html # 首页
└── README.md # 项目说明文档
目录介绍
_includes/
: 包含页面的部分内容,如头部、底部等。_layouts/
: 页面布局模板,定义了页面的基本结构。_posts/
: 博客文章存放目录,文章需遵循 Jekyll 的命名规范。_sass/
: SASS 样式文件,用于定义页面的样式。assets/
: 静态资源文件,如图片、CSS、JavaScript。_config.yml
: 项目配置文件,包含站点的基础配置信息。about.md
: 关于页面,用于展示项目或团队的介绍。index.html
: 首页,站点的入口页面。README.md
: 项目说明文档,提供项目的基本信息和使用说明。
2. 项目的启动文件介绍
Material Jekyll 主题的启动文件主要是 index.html
和 _config.yml
。
index.html
index.html
是站点的入口页面,定义了首页的基本结构和内容。它通常包含以下内容:
- 头部信息:包含页面的标题、描述等。
- 导航栏:提供站点的导航链接。
- 内容区域:展示博客文章或其他页面内容。
- 底部信息:包含版权声明、联系方式等。
_config.yml
_config.yml
是 Jekyll 项目的配置文件,包含站点的基础配置信息。它通常包含以下内容:
title
: 站点标题。email
: 联系邮箱。description
: 站点描述。baseurl
: 站点的基本路径。url
: 站点的完整 URL。theme
: 使用的主题名称。- 其他自定义配置项。
3. 项目的配置文件介绍
Material Jekyll 主题的配置文件是 _config.yml
,它包含了站点的所有基础配置信息。以下是一些常见的配置项:
title: 我的博客
email: example@example.com
description: 这是一个使用 Material Jekyll 主题的博客。
baseurl: ""
url: "http://example.com"
theme: material-jekyll-theme
# 其他自定义配置项
markdown: kramdown
highlighter: rouge
permalink: /:year/:month/:day/:title/
配置项介绍
title
: 站点的标题,会显示在页面的头部和标签页上。email
: 联系邮箱,用于用户反馈和联系。description
: 站点描述,用于搜索引擎优化。baseurl
: 站点的基本路径,通常为空字符串。url
: 站点的完整 URL,用于生成绝对路径。theme
: 使用的主题名称,这里是material-jekyll-theme
。markdown
: 使用的 Markdown 解析器,这里是kramdown
。highlighter
: 代码高亮工具,这里是rouge
。permalink
: 文章的永久链接格式,这里是/年/月/日/标题/
。
通过修改 _config.yml
文件,可以自定义站点的各种配置,以满足不同的需求。