Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.91 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.91 KB
Raw

清华大学飞跃数据库

清华大学飞跃数据库是一个收集并展示清华大学出国申请案例的数据库，旨在帮助同学们更好地了解往届同学的申请情况，为自己的申请提供参考。

数据库中的信息储存于 SeaTable 中，通过 API 读取并生成网页或 PDF——这使得对数据进行分类、分析成为可能。

网页使用 Material for MkDocs 生成，每 6 小时自动更新一次，并每周使用 Internet Archive 的 Wayback Machine 对文档进行快照。具体细节详见 Actions 页面。

PDF 由 XeLaTeX 编译 LaTeX 文件生成。我们将在每年的申请季开始前在 Release 页面发布 PDF 版本。

构建文档

安装依赖

pip3 install -r requirements.txt

如果构建为 LaTeX 项目，还需要安装 TeX Live（或使用 Docker）。

构建

目前支持构建为 MkDocs 网页或 LaTeX 文档（PDF）。访问 API 需要有 SeaTable 的 API Key，目前只有管理员具有访问权限。如果没有 API Key，请参考下文。

使用如下命令构建：

python3 maker.py --api-key=<seatable-api-key> --frontend={mkdocs|latex} [--link-resources] [--cached]
  • 使用 --link-resources 时，复制静态文档到输出文件夹时将直接创建符号链接，而不是复制文件，这样可以使得 MkDocs 检测到文件的更新，适合在本地开发时打开。
  • 使用 --cached 时，将会缓存 SeaTable 数据库的数据，而无需使用 API 查询数据库。

如果没有 API Key，可以到 publish Action 中最新的 run 处下载名为 database-backup 的 artifact，解压后将 .cache 目录复制到项目根目录下，并使用 --cached 参数即可。

预览/编译

MkDocs

构建完成后，MkDocs 项目将会被输出到 output 目录下。在 output 目录使用如下命令启动预览服务器：

mkdocs serve

LaTeX

构建完成后，LaTeX 文件将会被输出到 output/latex 目录下。在 output/latex 目录使用如下命令编译 PDF：

latexmk -xelatex -file-line-error -shell-escape -halt-on-error -interaction=nonstopmode main.tex

也可使用 Docker 编译：

docker run --rm -v $(pwd):/feiyue -w /feiyue ghcr.io/xu-cheng/texlive-full \
    latexmk -xelatex -file-line-error -shell-escape -halt-on-error -interaction=nonstopmode main.tex

项目结构

.
├── feiyue     # 项目主要代码
├── maker.py   # 构建脚本
├── resources  # 在构建时被直接复制的文件
├── scripts    # 一些脚本
└── templates  # 生成网页的模版