Zjuthesis 开源项目使用教程

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

Zjuthesis 项目的目录结构如下：

zjuthesis/
├── README.md
├── LICENSE
├── .gitignore
├── docs/
├── examples/
├── scripts/
├── src/
│   ├── common/
│   ├── figures/
│   ├── fonts/
│   ├── pages/
│   ├── style/
│   └── zjuthesis.tex
└── templates/

目录结构介绍

• README.md: 项目介绍文件。
• LICENSE: 项目许可证文件。
• .gitignore: Git 忽略文件配置。
• docs/: 项目文档目录。
• examples/: 项目示例目录。
• scripts/: 项目脚本目录。
• src/: 项目源代码目录。
  • common/: 通用代码文件。
  • figures/: 图片文件目录。
  • fonts/: 字体文件目录。
  • pages/: 页面内容文件目录。
  • style/: 样式文件目录。
  • zjuthesis.tex: 项目主文件。
• templates/: 模板文件目录。

2. 项目的启动文件介绍

项目的启动文件是 src/zjuthesis.tex。这个文件是整个项目的主文件，包含了项目的核心结构和配置。

启动文件内容概览

\documentclass{zjuthesis}

\begin{document}
    % 文档内容
\end{document}

• \documentclass{zjuthesis}: 定义文档类型为 zjuthesis。
• \begin{document} 和 \end{document}: 文档的开始和结束标记。

3. 项目的配置文件介绍

项目的配置文件主要分布在 src/ 目录下的各个子目录中，特别是 src/zjuthesis.tex 文件中包含了主要的配置信息。

配置文件内容概览

\documentclass[
    % 配置选项
]{zjuthesis}

• \documentclass[...]{zjuthesis}: 配置选项可以包括文档类型、语言、字体等。

例如：

\documentclass[
    type=bachelor,
    language=english,
    fontset=mac
]{zjuthesis}

• type=bachelor: 文档类型为本科生论文。
• language=english: 文档语言为英语。
• fontset=mac: 使用 Mac 字体设置。

这些配置选项可以根据具体需求进行调整。