开源项目 `good-clean-read` 使用教程

开源项目 good-clean-read 使用教程

good-clean-readA Jekyll template for publishing clean, readable articles and single-page sites项目地址:https://gitcode.com/gh_mirrors/go/good-clean-read

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

good-clean-read/
├── _config.yml
├── _data
│   └── members.yml
├── _includes
│   ├── footer.html
│   ├── head.html
│   ├── header.html
│   └── scripts.html
├── _layouts
│   ├── default.html
│   ├── home.html
│   ├── page.html
│   └── post.html
├── _posts
│   └── 2023-01-01-welcome-to-jekyll.markdown
├── _sass
│   ├── _base.scss
│   ├── _layout.scss
│   └── _syntax-highlighting.scss
├── assets
│   ├── css
│   │   └── main.scss
│   ├── images
│   └── js
├── Gemfile
├── Gemfile.lock
├── index.html
└── README.md

• _config.yml: 项目的配置文件。
• _data/members.yml: 存储项目成员信息的数据文件。
• _includes/: 包含页面的各个部分，如头部、尾部、脚本等。
• _layouts/: 定义页面的布局模板。
• _posts/: 存储博客文章的目录。
• _sass/: 包含SASS样式文件。
• assets/: 存储静态资源，如CSS、图片和JavaScript文件。
• Gemfile 和 Gemfile.lock: 定义项目依赖的Gem包。
• index.html: 项目的主页。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 index.html，这是访问项目时的默认入口文件。它包含了页面的基本结构和引用，如头部、尾部、脚本等，并通过 _layouts/home.html 模板来渲染页面内容。

3. 项目的配置文件介绍

项目的配置文件是 _config.yml，它包含了项目的基本配置信息，如站点标题、描述、URL、作者信息等。以下是一个示例配置：

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 文件，可以自定义站点的各种设置，包括主题、插件、作者信息等。

以上是 good-clean-read 项目的基本使用教程，希望对你有所帮助。

good-clean-readA Jekyll template for publishing clean, readable articles and single-page sites项目地址:https://gitcode.com/gh_mirrors/go/good-clean-read