SUDA-SE-lessons 项目启动与配置教程

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

SUDA-SE-lessons 项目是一个用于教学目的的开源项目，其目录结构如下：

SUDA-SE-lessons/
├── _book/
│   ├── README.md
│   ├── chapter1/
│   │   ├── lesson1.md
│   │   └── ...
│   ├── chapter2/
│   │   ├── lesson2.md
│   │   └── ...
│   └── ...
├── .gitignore
├── book.json
├── Gemfile
├── Gemfile.lock
├── Makefile
└── ...

主要目录和文件介绍：

• _book/: 存放生成的书籍文件，包括各个章节的 Markdown 文件。
• README.md: 项目的简介和说明。
• chapter1/, chapter2/: 各个章节的目录，每个章节包含多个 lesson 的 Markdown 文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• book.json: 配置生成书籍的相关参数和元数据。
• Gemfile, Gemfile.lock: Ruby 的依赖文件，用于管理项目所需的 Ruby 包。
• Makefile: 用于构建项目的 Makefile 文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 Makefile 文件，以下是 Makefile 的基本使用方法：

.PHONY: all html

all: html

html:
    make html

clean:
    rm -rf _book

启动步骤：

1. 在项目根目录下打开终端。
2. 运行 make html 命令，这将会生成 HTML 格式的书籍。
3. 生成的书籍文件将会位于 _book/ 目录下。

3. 项目的配置文件介绍

项目的配置主要通过 book.json 文件进行。以下是 book.json 文件的一个基本示例：

{
    "title": "SUDA-SE-lessons",
    "description": "上海大学软件学院软件工程课程教材",
    "language": "zh",
    "gitbook": "3.2.3",
    "structure": {
        "readme": "_book/README.md"
    },
    "plugins": [
        "donate"
    ],
    "pluginsConfig": {
        "donate": {
            "wechat": "wechat-code.jpg",
            "alipay": "alipay-code.jpg",
            "title": "您的支持是作者持续更新的动力",
            "button": "打赏",
            "alipayText": "支付宝打赏",
            "wechatText": "微信打赏"
        }
    }
}

配置说明：

• title: 项目的标题。
• description: 项目的描述。
• language: 项目的语言，此处为中文。
• gitbook: 使用的 GitBook 版本。
• structure: 指定项目的结构，例如 readme 指定 README 文件的路径。
• plugins: 安装的插件列表。
• pluginsConfig: 插件的配置信息。

通过修改 book.json 文件，可以根据需求定制书籍的样式和功能。