无须给本仓库Star, 建议给模板仓库点Star！有问题也需要在模板仓库提issues.

📚电子科技大学学位论文Typst模板实例

Important

本仓库是一个模板仓库, 在Github主页右上角可以看到一个 Use this template 按钮, 可以直接使用本仓库作为模板创建一个新的仓库.

各位同学可以在本仓库的基础上进行修改

模板本着内容于样式分离的原则, 本仓库基本除了内容不包含任何样式代码

🚀 快速开始

# 如果想尝试一下就下载这个
git clone https://github.com/qujihan/uestc-typst-thesis-example.git thesis
# 如果想使用Fork的仓库
git clone https://github.com/{YOUR-NAME}/uestc-typst-thesis-example.git thesis

cd thesis; 
git submodule update --init --recursive

# 生成一个名为 学位论文写作指南及例子.pdf 的文件
# 可以在 makefile 中修改生成的文件名
make build

# 生成一个名为 学位论文写作指南及例子.pdf 的文件, 并且随着写作实时预览
# 可以在 makefile 中修改生成的文件名
make watch

当 Fork 本仓库后需要更改的事情

建议修改

• 修改.vscode/settings.json文件
  • 将学位论文写作指南及例子.pdf修改为需要的名字(务必以.pdf结尾)
  • 修改tinymist.exportPdf参数(我不需要自动构建, 因为会卡, 你可以通过需求修改)

🏔️ 流水线构建(如果只想本地写可以忽略)

可以在 .github/workflows/ci.yml 文件中修改流水线构建的配置. 比如流水线的名称, 触发条件, 构建命令等

默认操作是：向任意分支push代码后, 会将所有pdf文件强制推送到output分支(之前生成的文件会被覆盖)