modern-ucas-thesis:0.2.0

packages/preview/modern-ucas-thesis/0.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 OrangeX4
+Copyright (c) 2025 Vncntvx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/modern-ucas-thesis/0.2.0/Makefile

@@ -0,0 +1,159 @@
+# Makefile for Typst UCAS Thesis
+# 使用 typstyle 格式化 Typst 代码
+
+# 定义变量
+TYPSTYLE = typstyle
+TYPST_FILES = $(shell find . -name "*.typ" -not -path "./node_modules/*" -not -path "./.git/*")
+MAIN_FILES = lib.typ template/thesis.typ
+PACKAGE_CHECK = package-check
+
+# 默认目标
+.PHONY: help
+help:
+	@echo "可用的命令："
+	@echo "  make format        - 格式化所有 .typ 文件"
+	@echo "  make format-main   - 仅格式化主要文件 (lib.typ, template/thesis.typ)"
+	@echo "  make format-check  - 检查代码格式但不修改文件"
+	@echo "  make lint          - 运行包检查 (需要安装 package-check)"
+	@echo "  make lint-install  - 安装 package-check 工具"
+	@echo "  make list-files    - 列出所有将被格式化的 .typ 文件"
+	@echo ""
+	@echo "详细使用说明请参考: docs/FORMAT.md"
+
+# 格式化所有 .typ 文件
+.PHONY: format
+format:
+	@echo "正在格式化所有 Typst 文件..."
+	@for file in $(TYPST_FILES); do \
+		echo "格式化: $$file"; \
+		$(TYPSTYLE) --inplace "$$file" || echo "警告: 格式化 $$file 失败"; \
+	done
+	@echo "格式化完成！"
+
+# 仅格式化主要文件
+.PHONY: format-main
+format-main:
+	@echo "正在格式化主要文件..."
+	@for file in $(MAIN_FILES); do \
+		if [ -f "$$file" ]; then \
+			echo "格式化: $$file"; \
+			$(TYPSTYLE) --inplace "$$file" || echo "警告: 格式化 $$file 失败"; \
+		else \
+			echo "文件不存在: $$file"; \
+		fi; \
+	done
+	@echo "主要文件格式化完成！"
+
+# 检查代码格式（不修改文件）
+.PHONY: format-check
+format-check:
+	@echo "检查代码格式..."
+	@failed=0; \
+	for file in $(TYPST_FILES); do \
+		echo "检查: $$file"; \
+		if ! $(TYPSTYLE) --check "$$file" >/dev/null 2>&1; then \
+			echo "❌ $$file 需要格式化"; \
+			failed=1; \
+		else \
+			echo "✅ $$file 格式正确"; \
+		fi; \
+	done; \
+	if [ $$failed -eq 1 ]; then \
+		echo ""; \
+		echo "有文件需要格式化，请运行 'make format'"; \
+		exit 1; \
+	else \
+		echo ""; \
+		echo "所有文件格式正确！"; \
+	fi
+
+# 列出所有将被格式化的文件
+.PHONY: list-files
+list-files:
+	@echo "将被格式化的 .typ 文件："
+	@for file in $(TYPST_FILES); do \
+		echo "  $$file"; \
+	done
+
+# 清理生成的文件
+.PHONY: clean
+clean:
+	@echo "清理生成的文件..."
+	@find . -name "*.pdf" -not -path "./template/thesis.pdf" -delete
+	@echo "清理完成！"
+
+# 格式化指定文件（使用方法: make format-file FILE=path/to/file.typ）
+.PHONY: format-file
+format-file:
+	@if [ -z "$(FILE)" ]; then \
+		echo "错误: 请指定文件路径，例如: make format-file FILE=lib.typ"; \
+		exit 1; \
+	fi
+	@if [ ! -f "$(FILE)" ]; then \
+		echo "错误: 文件不存在: $(FILE)"; \
+		exit 1; \
+	fi
+	@echo "格式化文件: $(FILE)"
+	@$(TYPSTYLE) --inplace "$(FILE)"
+	@echo "格式化完成！"
+
+# 显示项目统计信息
+.PHONY: stats
+stats:
+	@echo "项目统计信息："
+	@echo "  Typst 文件数量: $$(echo '$(TYPST_FILES)' | wc -w)"
+	@echo "  总行数: $$(cat $(TYPST_FILES) | wc -l)"
+	@echo "  主要文件: $(MAIN_FILES)"
+
+# ============ 包检查 (Lint) ============
+
+# 安装 package-check 工具
+.PHONY: lint-install
+lint-install:
+	@echo "正在安装 typst/package-check..."
+	@if command -v cargo >/dev/null 2>&1; then \
+		echo "使用 cargo 安装..."; \
+		cargo install --git https://github.com/typst/package-check.git; \
+	else \
+		echo "❌ 请先安装 Rust/Cargo: https://rustup.rs/"; \
+		exit 1; \
+	fi
+	@echo "✅ package-check 安装完成！"
+
+# 运行包检查（需要在本地有完整的 package index）
+.PHONY: lint
+lint:
+	@echo "运行 Typst 包检查..."
+	@if ! command -v $(PACKAGE_CHECK) >/dev/null 2>&1; then \
+		echo "❌ package-check 未安装"; \
+		echo "   请运行: make lint-install"; \
+		exit 1; \
+	fi
+	@echo "检查包结构和元数据..."
+	@$(PACKAGE_CHECK) . || (echo "❌ 包检查失败"; exit 1)
+	@echo "✅ 包检查通过！"
+
+# 快速检查（不依赖外部 index，仅检查基本结构）
+.PHONY: lint-quick
+lint-quick:
+	@echo "运行快速包检查..."
+	@echo "检查 typst.toml..."
+	@if [ ! -f "typst.toml" ]; then \
+		echo "❌ typst.toml 不存在"; \
+		exit 1; \
+	fi
+	@echo "✅ typst.toml 存在"
+	@echo "检查必要字段..."
+	@grep -q "^name = " typst.toml || (echo "❌ 缺少 name 字段"; exit 1)
+	@grep -q "^version = " typst.toml || (echo "❌ 缺少 version 字段"; exit 1)
+	@grep -q "^entrypoint = " typst.toml || (echo "❌ 缺少 entrypoint 字段"; exit 1)
+	@echo "✅ 基本字段完整"
+	@echo "检查入口文件..."
+	@entrypoint=$$(grep "^entrypoint = " typst.toml | sed 's/.*= "\(.*\)".*/\1/'); \
+	if [ ! -f "$$entrypoint" ]; then \
+		echo "❌ 入口文件 '$$entrypoint' 不存在"; \
+		exit 1; \
+	fi
+	@echo "✅ 入口文件存在"
+	@echo ""
+	@echo "✅ 快速检查通过！"

packages/preview/modern-ucas-thesis/0.2.0/README.md

@@ -0,0 +1,174 @@
+<h1 align="center">modern-ucas-thesis</h1>
+
+<p align="center">
+  <a href="docs/README_EN.md">English</a> | <strong>中文</strong>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/status-beta-blue?style=flat-square" alt="Project Status">
+  <img src="https://img.shields.io/github/last-commit/Vncntvx/modern-ucas-thesis?style=flat-square" alt="Last Commit">
+  <img src="https://img.shields.io/github/issues/Vncntvx/modern-ucas-thesis?style=flat-square" alt="Issues">
+  <img src="https://img.shields.io/github/license/Vncntvx/modern-ucas-thesis?style=flat-square" alt="License">
+</p>
+
+基于 [Typst](https://typst.app/) 的中国科学院大学学位论文，参考《中国科学院大学研究生学位论文撰写规范指导意见（2022年）》格式要求。
+
+> ⚠️ **免责声明**：本项目非官方出品，使用前请自行核对学校最新格式要求。
+---
+
+## 快速开始
+
+### 1. 安装 Typst
+
+```bash
+# macOS
+brew install typst
+
+# Windows
+winget install --id Typst.Typst
+
+# 或使用官方安装脚本
+curl -fsSL https://typst.community/install | sh
+```
+
+### 2. 使用模板
+
+```bash
+# 克隆仓库
+git clone https://github.com/Vncntvx/modern-ucas-thesis.git
+cd modern-ucas-thesis
+
+# 编译论文
+typst compile template/thesis.typ
+
+# 或开启实时预览
+typst watch template/thesis.typ
+```
+
+### 3. 配置论文信息
+
+编辑 `template/thesis.typ`：
+
+```typst
+#import "../lib.typ": *
+
+#show: documentclass.with(
+  title: "论文标题",
+  author: "作者姓名",
+  supervisor: "导师姓名",
+  degree: "博士",
+  major: "计算机科学与技术",
+)
+
+// 开始撰写...
+```
+
+---
+
+## 项目结构
+
+```
+modern-ucas-thesis/
+├── template/          # 论文源文件
+│   ├── thesis.typ    # 主文件
+│   ├── ref.bib       # 参考文献
+│   └── images/       # 图片目录
+├── pages/            # 页面模板（封面、摘要等）
+├── layouts/          # 布局模板（前言、正文、附录）
+├── utils/            # 工具函数
+├── lib.typ           # 主库入口
+└── docs/             # 文档
+```
+
+---
+
+## 功能支持
+
+- **说明文档**
+  - [ ] 编写更详细的说明文档，现在可以先参考 [NJUThesis](https://mirror-hk.koddos.net/CTAN/macros/unicodetex/latex/njuthesis/njuthesis.pdf) 的文档，参数大体保持一致，或者直接查阅对应源码函数的参数
+- **类型检查**
+  - [ ] 应该对所有函数入参进行类型检查，及时报错
+- **全局配置**
+  - [x] 类似 LaTeX 中的 `documentclass` 的全局信息配置
+  - [x] **盲审模式**，将个人信息替换成小黑条，并且隐藏致谢页面，论文提交阶段使用
+  - [x] **双面模式**，会加入空白页，便于打印
+  - [x] **自定义字体配置**，可以配置「宋体」、「黑体」与「楷体」等字体对应的具体字体
+  - [x] **数学字体配置**：模板不提供配置，用户可以自己使用 `#show math.equation: set text(font: "Fira Math")` 更改
+- **模板**
+  - [ ] 本科生模板
+    - [ ] 字体测试页
+    - [ ] 封面
+    - [ ] 声明页
+    - [x] 中文摘要
+    - [x] 英文摘要
+    - [x] 目录页
+    - [x] 插图目录
+    - [x] 表格目录
+    - [x] 符号表
+    - [ ] 致谢
+  - [x] 研究生模板
+    - [x] 封面
+    - [x] 声明页
+    - [x] 中文摘要
+    - [x] 英文摘要
+    - [ ] 目录页
+    - [x] 图表目录
+    - [x] 双语图表标题
+    - [x] 符号表
+    - [ ] 页眉
+    - [ ] 致谢
+    - [ ] 作者简历
+  - [ ] 博士后模板
+- **编号**
+  - [x] 前言使用罗马数字编号
+  - [x] 附录使用罗马数字编号
+  - [x] 表格使用 `1.1` 格式进行编号
+  - [x] 数学公式使用 `(1.1)` 格式进行编号
+- **环境**
+  - [ ] 定理环境（这个也可以自己使用第三方包配置）
+- **其他文件**
+  - [ ] 本科生开题报告
+  - [ ] 研究生开题报告
+
+---
+
+## 文档
+
+- [定制指南](docs/CUSTOMIZE.md)
+- [常见问题](docs/FAQ.md)
+- [格式化工具](docs/FORMAT.md)
+
+---
+
+## 开发
+
+```bash
+# 格式化代码
+make format
+
+# 检查格式
+make format-check
+```
+
+---
+
+## 致谢
+
+- 基于 [modern-nju-thesis](https://github.com/nju-lug/modern-nju-thesis) 开发
+- 参考 [ucasthesis](https://github.com/mohuangrui/ucasthesis) LaTeX 模板
+
+---
+
+## 许可证
+
+本项目代码采用 [MIT](LICENSE) 许可证开源。
+
+**关于 UCAS 标识**：`assets/vi/` 目录下的校徽、Logo 等视觉标识的版权归中国科学院大学所有。本项目将其纳入仅为方便用户撰写学位论文（属于个人学习/教学合理使用范畴），请勿用于其他商业或官方用途。如需商用授权，请联系学校相关部门。详见 [docs/LOGO_COPYRIGHT.md](docs/LOGO_COPYRIGHT.md)。
+
+---
+
+<p align="center">
+  <a href="https://github.com/Vncntvx/modern-ucas-thesis/issues">报告问题</a> ·
+  <a href="https://github.com/Vncntvx/modern-ucas-thesis/discussions">讨论交流</a> ·
+  <a href="https://github.com/Vncntvx/modern-ucas-thesis/pulls">贡献代码</a>
+</p>