HUST-typst-template 项目使用教程

HUST-typst-template 项目使用教程

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

HUST-typst-template 项目的目录结构如下：

HUST-typst-template/
├── assets/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bibitems.yaml
├── cs-template.typ
├── cse-template.typ
├── hust-cs.csl
├── hust-cse-ug.csl
├── ref.bib
├── sample.pdf
└── sample.typ

目录结构介绍

• assets/: 存放项目相关的资源文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• bibitems.yaml: 参考文献配置文件。
• cs-template.typ: 计算机学院模板文件。
• cse-template.typ: 网络安全学院模板文件。
• hust-cs.csl: 计算机学院样式文件。
• hust-cse-ug.csl: 网络安全学院本科样式文件。
• ref.bib: 参考文献数据库文件。
• sample.pdf: 示例生成的 PDF 文件。
• sample.typ: 示例 Typst 文件。

2. 项目的启动文件介绍

项目的启动文件是 sample.typ，这是一个示例 Typst 文件，用于演示如何使用模板生成毕业论文。

sample.typ 文件内容概览

# 导入所需的模板文件
import "cs-template.typ"

# 设置文档标题、作者等信息
title: "示例毕业论文"
author: "张三"
date: "2024年5月"

# 正文内容
...

3. 项目的配置文件介绍

bibitems.yaml

bibitems.yaml 文件用于配置参考文献的格式和内容。

cs-template.typ 和 cse-template.typ

cs-template.typ 和 cse-template.typ 分别是计算机学院和网络安全学院的模板文件，包含了论文的格式和样式定义。

hust-cs.csl 和 hust-cse-ug.csl

hust-cs.csl 和 hust-cse-ug.csl 是样式文件，定义了参考文献的显示格式。

ref.bib

ref.bib 是参考文献数据库文件，包含了所有引用的文献信息。

通过以上配置文件和启动文件，用户可以快速生成符合华科毕业论文要求的 PDF 文档。