BUPT-Typst 项目使用教程
1. 项目的目录结构及介绍
bupt-typst/
├── images/
│ └── bupt.png
├── .gitignore
├── LICENSE
├── README.md
├── gb-t-7714-2015-numeric.csl
├── main.typ
├── reference.bib
├── reference.yml
├── template.typ
└── FZKTK.ttf
目录结构介绍
- images/: 存放项目所需的图片文件,如
bupt.png
。 - .gitignore: Git 忽略文件,指定哪些文件或目录不需要被 Git 管理。
- LICENSE: 项目的开源许可证文件,本项目使用 MIT 许可证。
- README.md: 项目的说明文档,包含项目的基本信息和使用指南。
- gb-t-7714-2015-numeric.csl: 参考文献格式文件。
- main.typ: 项目的主文件,包含论文的主要内容。
- reference.bib: 参考文献文件,使用 BibTeX 格式。
- reference.yml: 参考文献配置文件。
- template.typ: 论文模板文件。
- FZKTK.ttf: 字体文件,用于本地编译时的字体支持。
2. 项目的启动文件介绍
main.typ
main.typ
是项目的主文件,包含了论文的主要内容。用户可以通过编辑此文件来撰写自己的毕业论文。
// main.typ 文件示例
#import "template.typ": *
#title("北京邮电大学本科生毕业论文")
#author("张三")
#date("2023年6月")
#section("摘要")
本文介绍了...
#section("引言")
引言部分...
#section("正文")
正文部分...
#section("结论")
结论部分...
启动步骤
- 在线编辑: 进入 Typst 官网,将本模板的文件导入进去。需要导入一些在线编辑器暂不支持的字体(如楷体)。
- 本地编译: 进入 Typst 的 GitHub 仓库,下载 release,解压出
typst.exe
放入根目录。执行以下命令进行编译:typst compile --font-path path/to/fonts main.typ
3. 项目的配置文件介绍
reference.bib
reference.bib
是参考文献文件,使用 BibTeX 格式。用户可以在此文件中添加和管理参考文献。
@article{author2023,
title={论文标题},
author={作者},
journal={期刊名称},
year={2023},
volume={1},
number={1},
pages={1-10}
}
reference.yml
reference.yml
是参考文献配置文件,用于配置参考文献的格式和样式。
citation-style: gb-t-7714-2015-numeric.csl
bibliography: reference.bib
template.typ
template.typ
是论文模板文件,定义了论文的基本结构和样式。
#import "gb-t-7714-2015-numeric.csl": *
#title("北京邮电大学本科生毕业论文")
#author("张三")
#date("2023年6月")
#section("摘要")
本文介绍了...
#section("引言")
引言部分...
#section("正文")
正文部分...
#section("结论")
结论部分...
通过以上配置文件和模板文件,用户可以自定义论文的格式和内容,满足北京邮电大学本科生毕业论文的要求。