南京大学学位论文Typst模板使用指南

1. 项目目录结构及介绍

南京大学学位论文Typst模板，位于GitHub仓库 nju-lug/nju-thesis-typst，提供了高效撰写学术论文的框架。以下是该模板的基本目录结构及其功能介绍：

nju-thesis-typst/
├── assets/                 # 存放静态资源，如图片、图标等
│
├── src/                    # 核心源代码目录
│   ├── main.typ           # 入口文件，定义论文的主体结构和章节引入
│   ├── frontmatter.typ    # 封面、声明、摘要等前置部分
│   ├── introduction.typ   # 引言或第一章内容
│   └── ...                # 更多章节文件，按需添加
│
├── styles/                 # 自定义样式，包括字体、颜色等CSS类的Typst等效定义
│
├── config.yaml             # 配置文件，用于定制编译选项和全局设置
│
└── README.md               # 项目说明文档

• assets: 存储所有非文本资源。
• src: 包含了论文的主要内容，划分为多个.typ文件以组织不同章节。
• styles: 定义整个文档的样式，允许高度自定义外观。
• config.yaml: 关键配置项，控制编译行为和一些元数据。

2. 项目的启动文件介绍

main.typ 是项目的启动文件，它扮演着至关重要的角色。在此文件中，你会导入其他所有的章节文件，并设定论文的整体架构。例如，其结构通常包含以下部分：

% 在顶部可能包含文档类定义和其他预设
\documentclass[nju]{nju-thesis}

\begin{document}

\frontmatter
\input{./src/frontmatter.typ} % 前置内容如封面、声明、目录等

\mainmatter
\input{./src/introduction.typ} % 引言部分
\input{./src/chapter1.typ}     % 第一章的具体内容
% 可继续加入更多章节...

\appendix
% 如果有附录，可以从这里开始输入相关章节

\backmatter
% 致谢、参考文献等一般放在文档最后

\end{document}

通过\input命令引入各个章节文件，保证了论文各部分内容的模块化管理。

3. 项目的配置文件介绍

config.yaml 文件是模板的配置中心，允许用户进行个性化调整，无需深入源码即可修改编译设置或论文基本属性。示例配置可能包含：

# 示例config.yaml结构
project:
  title: "南京大学学位论文示例"
  author: "你的名字"
  degree: "硕士学位"
  
compile:
  typst:
    command: "typst"
    outputFormat: "pdf"
    view: true
    # 更多编译相关的定制参数

style:
  # 这里可以指定或覆盖默认的风格设置，比如字体大小、颜色主题等
  
metadata:
  language: "zh-CN"
  # 论文的其他元数据，如关键词、提交日期等

配置项涵盖了从输出格式到文档元数据的广泛设置，确保论文符合个人需求及学校规定。通过调整这些值，作者可以轻松地定制他们的论文外观和编译流程。