开源项目 Freshman21 教程
freshman21Welcome to use Jekyll theme Freshman21. 项目地址:https://gitcode.com/gh_mirrors/fr/freshman21
1. 项目的目录结构及介绍
Freshman21 是基于 Jekyll 的一款博客主题,它致敬了 WordPress 的 Twenty-Twelve 和 Twenty-eleven 主题。以下是该主题的基本目录结构及其简介:
.
├── _includes # 包含各种页面部分(如页眉、页脚)的模板文件。
├── _layouts # 网站布局文件,定义了页面的公共布局。
├── _posts # 博客文章存放的目录,每篇文章都是一个 Markdown 文件。
├── _sass # SCSS 源代码文件夹,用于存储主题的样式表。
├── css # 编译后的 CSS 样式文件。
├── images # 图片资源存储目录。
├── gitignore # Git 忽略文件列表。
├── LICENSE # 许可证文件,本项目遵循 MIT 许可证。
├── README.md # 项目介绍和说明文档。
├── _config.yml # Jekyll 配置文件,设置站点元数据和插件等。
├── index.html # 主页 HTML 文件。
└── feed.xml # RSS 订阅文件。
2. 项目的启动文件介绍
主要的启动过程围绕着 _config.yml
和 index.html
文件进行。其中,_config.yml
是项目的配置中心,决定了网站的基础设置和行为。而 index.html
则是网站的首页,虽然在开发过程中可能会被其他布局或自动化流程间接引用。
-
_config.yml: 这个 YAML 格式的文件包含了站点的元数据,比如站点标题、描述、作者信息、导航菜单链接以及Jekyll的各种配置选项,比如启用或禁用某些特性,设置默认语言等。编辑这个文件可以不编译全部文档就能改变整个站点的行为和外观。
-
index.html: 作为前端展示的核心,它可能直接或者通过Jekyll的布局系统间接地使用,展示最新的博客文章或是主页的定制化内容。在Jekyll中,这通常不会单独“启动”,而是由Jekyll编译流程处理并集成到最终构建的网站中。
3. 项目的配置文件介绍
_config.yml 配置详解
_config.yml 是 Freshman21 主题中最为关键的配置文件,以下是一些常见的配置项示例:
title: 我的博客 # 站点标题
author: 你的名字 # 作者名称
email: you@example.com # 联系邮箱
description: > # 网站描述,通常用于SEO优化
这里写上你的个人博客或网站的简短描述。
# 社交账号
social:
- icon: twitter
url: https://twitter.com/your-twitter
- icon: github
url: https://github.com/your-github
# Site settings
theme: freshman21 # 当前使用的主题
paginate: 5 # 分页的数量
paginate_path: "page:num" # 分页路径
# Markdown设置
markdown: kramdown
以上配置仅仅是冰山一角,《_config.yml》允许高度定制,从站点基础信息到第三方服务整合,再到Jekyll特性的开关,都可通过修改此文件来实现。确保在修改之前阅读Jekyll的官方文档以了解所有可用配置项,以及主题作者提供的特定指南。记得每次更改配置后重新生成站点以查看效果。
freshman21Welcome to use Jekyll theme Freshman21. 项目地址:https://gitcode.com/gh_mirrors/fr/freshman21