关于 NJUPT-General-Free-Exams 的特别说明

NJUPT-General-Free-Exams 是我们的通识课资料仓库。不同于其他仓库，该仓库目前建立了一个特殊的门户网站，用于项目介绍、资料展示等。因此，这里是一些特别的说明。

贡献文件的存放位置

在前面的介绍和指南中，我们已经介绍了贡献资料的一般方法，并且特别指出了对于此仓库，您应该将资料贡献至 public/ 或 src/content/docs/reserved/ 目录下。为什么要这样做？

在开始之前，让我们先来观察一下本项目的目录结构，参考如下：

文件夹public/
- …
文件夹src
- 文件夹assets/
  - …
- 文件夹components/
  - …
- 文件夹content
  - 文件夹docs
    文件夹home/
    …
    文件夹reserved/
    …
    …
  - …
- …
astro.config.mjs
package.json
…

为什么 Markdown 格式的资料需要放入 src/content/docs/reserved/ 目录下呢？这是因为我们希望您的资料能够直接显示在门户网站上。这样，同学们可以更方便地查看您的资料。

我们的门户网站是使用 Astro 构建的，并且使用了 starlight 这个模板。src/content/ 这个特殊的目录是 Astro 中用于存放内容集合的目录，而其中的 docs/ 则是 starlight 的要求。在您将资料放入 src/content/docs/reserved/ 目录下后，在构建网站时，Astro 和 starlight 将直接能够读取这些资料，以便将其直接显示在门户网站上。

如何添加学院

为了添加或更新学院分类，您需要：

前往 src/content/docs/ 并添加一个语意性的目录。可以参考我们已经建立的目录的命名，例如对应 “计算机学院” 的 computer-science 目录。
编辑 astro.config.mjs 文件。

如何添加课程

为了添加一门课程，您需要：

前往 public/ 并添加一个以课程名称命名的目录。
前往 src/content/docs/ 目录，找到所开课程对应学院的目录，并添加一个 Markdown 文件。文件名为课程名称。文件内容必须包含 Frontmatter，其中 title 为课程名称。

如何为门户网站本身贡献代码

如果您希望为门户网站本身贡献代码，您需要了解一些前端技术的基本知识。以下文档将会对您有所帮助：