CS107e GitHub.io 项目启动与配置教程

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

CS107e GitHub.io 项目是一个开源项目，主要用于支持和展示 CS107e 课程的相关资料。以下是项目的目录结构及其简要介绍：

.
├── _assets       # 存放静态资源，如图片、CSS、JavaScript 文件等
├── _data         # 存放数据文件，如课程信息、教师信息等
├── _includes     # 存放页面中复用的包含文件，如页头、页脚等
├── _layouts      # 存放布局文件，用于定义页面布局
├── _sass         # 存放 Sass 文件，用于生成 CSS
├── cs107e        # 存放课程相关的文档和资料
├── guides        # 存放教程和指南
├── readings      # 存放阅读材料
├── website       # 存放网站相关的页面和文章
├── .DS_Store      # Mac 系统生成的文件夹，通常包含桌面和文件夹的图标位置信息
├── 107efaq.md    # 课程常见问题解答的 Markdown 文件
├── Gemfile       # Ruby 的依赖文件，用于定义项目依赖的 Ruby 库
├── LICENSE.txt   # 项目的许可证文件
├── README.md     # 项目的自述文件
├── _config.yml   # Jekyll 的配置文件
├── _config_local.yml # 本地环境的配置文件，通常包含敏感信息
├── header.md     # 页头部分的 Markdown 文件
└── src.md        # 源代码文件的 Markdown 文件

2. 项目的启动文件介绍

项目的启动主要是通过 Jekyll 来进行的。以下是主要的启动文件及其介绍：

• README.md：项目的自述文件，通常包含了项目的介绍、安装步骤、使用指南等。
• Gemfile：定义了项目依赖的 Ruby 库。在使用 Jekyll 前，需要使用 bundle install 来安装这些依赖。
• _config.yml：Jekyll 的配置文件，用于定义网站的基本信息和布局等。

启动项目的基本步骤如下：

1. 克隆项目到本地：git clone https://github.com/cs107e/cs107e.github.io.git
2. 安装项目依赖：bundle install
3. 启动 Jekyll 服务：bundle exec jekyll serve

3. 项目的配置文件介绍

项目的配置主要通过 _config.yml 文件进行。以下是一些常见的配置选项：

• title：网站标题。
• description：网站描述。
• url：网站的 URL。
• baseurl：如果网站部署在子目录中，需要设置基路径。
• collections：定义项目中的集合，如文章、教程等。
• plugins：指定 Jekyll 插件。
• markdown：设置 Markdown 渲染引擎。

_config_local.yml 文件通常用于本地开发环境的配置，可能包含一些敏感信息，如 API 密钥等，因此不应该提交到公共仓库中。