https://github.com/iydon/sustechthesis

南方科技大学本科生毕业论文 LaTeX 模板
https://github.com/iydon/sustechthesis

latex-template sustex todo

Last synced: about 1 month ago
JSON representation

南方科技大学本科生毕业论文 LaTeX 模板

• Host: GitHub
• URL: https://github.com/iydon/sustechthesis
• Owner: iydon
• License: lppl-1.3c
• Created: 2018-08-24T08:11:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-03-19T13:54:45.000Z (3 months ago)
• Last Synced: 2025-04-19T14:02:58.390Z (2 months ago)
• Topics: latex-template, sustex, todo
• Language: TeX
• Homepage:
• Size: 45 MB
• Stars: 280
• Watchers: 3
• Forks: 65
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 南方科技大学本科学位论文模板 sustechthesis

[![Actions Status](https://github.com/Iydon/sustechthesis/actions/workflows/compile.yaml/badge.svg)](https://github.com/Iydon/sustechthesis/actions/workflows/compile.yaml)

[![GitHub downloads](https://img.shields.io/github/downloads/Iydon/sustechthesis/total)](https://github.com/Iydon/sustechthesis/releases)

[![Download Analysis](https://img.shields.io/badge/Download-Analysis-blue.svg)](https://qii404.me/github-release-statistics/?repo=/Iydon/sustechthesis/)

[![GitHub commits](https://img.shields.io/github/commits-since/Iydon/sustechthesis/latest)](https://github.com/Iydon/sustechthesis/commits/master)

[![GitHub release](https://img.shields.io/github/v/release/Iydon/sustechthesis?&label=%E5%8F%91%E5%B8%83%E7%89%88)](https://github.com/Iydon/sustechthesis/releases/latest)

[](https://api.gitsponsors.com/api/badge/link?p=JeMxbHPUXYGtd9jpmI1SGvSHERLVDdX8cJ/FSfiNlmd6RCoLknBEFajyjqU/ynhZQwglE1S31txO2IaNctV2pdO8wqSaqivbkLf8N672v89sWdbava9ATehxrhSaHkiCtfFEu9G6R8rCF8wNXUfQWg==)

Southern University of Science and Technology Thesis Template LaTeX Template for bachelor's degree.

## 下载

* 发布版：[GitHub Release](https://github.com/Iydon/sustechthesis/releases/latest)

* 开发版：直接 Git clone，或者点击绿色 `Code` 下载ZIP压缩包。此版本不保证稳定性，提供给有经验的 TeX 用户使用。

## 模板使用

请阅读 [main.pdf 文档](https://github.com/Iydon/sustechthesis/releases/latest)。

## 文档架构

* `config/preamble.tex`: 导言区，导入宏包，宏定义。

* `config/info.tex`: 论文信息，例如：标题，作者，等。

* `main.tex`: 主文档，编排章节顺序。

* `slides.tex`: beamer 幻灯片模版。

## XeLaTeX 构建

- 使用 Makefile: `make`, `make clean` ......

- 或，使用 `latexmk`

    - 构建: `latexmk main`

    - 清理: `latexmk -c main`

## 使用 LaTeX 在线编辑器

* 使用 [Overleaf](https://www.overleaf.com/)（需要科学上网保证稳定使用），上传 zip 压缩包后，更改编译器为 `XeLaTeX`

  * ⚠️ 由于Overleaf将免费账户的超时时间缩短到20秒，因此如果您在使用免费账户，可能无法成功完成项目的编译。[Overleaf官方声明](https://www.overleaf.com/blog/changes-to-free-compile-timeouts-and-servers)

* 使用 [南科大 ShareLaTeX](https://sharelatex.cra.moe/)，使用方式与Overleaf相同，上传 zip 压缩包后，更改编译器为 `XeLaTeX`。

* 使用 [TeXPage](https://www.texpage.com/)，使用方式与Overleaf类似，上传 zip 压缩包后，选择编译的主文档，并将编译选项设置为 `XeLaTeX`。

* 使用 [LoongTeX](https://www.loongtex.com/)，使用方式与VS Code类似，上传 zip 压缩包后，选择编译的主文档，并将编译选项设置为 `XeLaTeX`。

## 更新日志

每个版本的详细更新日志，请见 [CHANGELOG.md](CHANGELOG.md)。

## 正式版本发布流程

1. 手动更新 CHANGELOG.md

2. 手动更新 sustechthesis.cls 中定义的版本号 `\version`

3. 使用 git 命令行工具，打 tag 并推送到远端仓库

```git

#标记本地tag

git tag v1.2.0

#推送本地tag到远程

git push origin v1.2.0

#删除本地tag

git tag -d v1.2.0

#删除远程tag

git push --delete origin v1.2.0

```

## 致谢

* 本模版根据南方科技大学-教学工作部发布的相关 [《撰写规范》和《样例》](http://tao.sustech.edu.cn/studentService/graduation_project.html) 编写，如有冲突以官网规定为准。

  * 如果《样例》中存在与《撰写规范》中的规定不符之处，以《撰写规范》中的文字叙述为准。