浙江大学课程攻略共享计划（ZJU-Icicles）使用教程

浙江大学课程攻略共享计划（ZJU-Icicles）使用教程

zju-icicles浙江大学课程攻略共享计划项目地址:https://gitcode.com/gh_mirrors/zj/zju-icicles

本教程将指导您了解并使用ZJU-Icicles项目，这是一个由浙江大学学生维护的课程攻略共享平台。

1. 项目目录结构及介绍

ZJU-Icicles的目录结构如下：

.
├── Handbook                # 主要的手册内容
│   ├── 程序设计基础         # 以课程为例的具体攻略
│   └── ...                  # 其他课程攻略
├── Docs                    # 文档相关资料
├── Scripts                 # 辅助脚本
├── Website                 # 项目网站源代码
└── ...

• Handbook: 存放各个课程的攻略和指南，每个课程下都有相应的Markdown文件。
• Docs: 包含项目相关的文档和说明。
• Scripts: 提供了一些辅助脚本，用于自动化处理或构建任务。
• Website: 项目网页的源码，通常基于静态网站生成器如Jekyll或Hugo。

2. 项目的启动文件介绍

由于ZJU-Icicles主要是面向阅读的静态站点，它没有一个典型的"启动文件"来运行服务器。不过，如果您想本地预览或构建网站，需要关注以下文件：

• Website/_config.yml: Jekyll的配置文件，用于设置网站的基本参数和元数据。
• Website/_includes: 包含了网站模板的片段。
• Website/_layouts: 定义页面布局的模板。
• Website/generate.py: 用于生成静态HTML文件的Python脚本，通常使用python generate.py执行。

执行generate.py后，静态站点会被构建到Website/_site目录下，可以使用本地Web服务器浏览这些文件以查看效果。

3. 项目的配置文件介绍

主要的配置文件是Website/_config.yml，包括但不限于以下关键配置项：

# _config.yml

title: 浙江大学课程攻略共享计划
description: ZJU-Icicles course handbooks
baseurl: "" # 静态站点的基础URL，通常是部署时的子路径
url: "http://qsctech.github.io/zju-icicles/" # 正式网站地址
repository: "QSCTech/zju-icicles"
paginate_path: "page:num/"
plugins:
  - jekyll-paginate
  - jekyll-github-metadata

这个文件定义了网站的基本信息，如标题、描述、URL以及使用的插件等。如果你在本地运行或者要更改网站外观，可能需要修改这里的内容。

完成以上步骤后，您应该对ZJU-Icicles项目有了初步了解，可以根据自己的需求进一步探索和贡献课程攻略。祝您使用愉快！

zju-icicles浙江大学课程攻略共享计划项目地址:https://gitcode.com/gh_mirrors/zj/zju-icicles