modern-ucas-thesis

A Typst-based thesis template for the University of Chinese Academy of Sciences (UCAS), following the UCAS Graduate Thesis Writing Guidelines (2022) and the UCAS Undergraduate Thesis (Design) Writing Guidelines (2023-10 revision).

⚠️ Disclaimer: This project is not officially produced. Verify the latest format requirements from the university before use.

Quick Start

1. Install Typst

# macOS
brew install typst

# Windows
winget install --id Typst.Typst

# Or use the official installation script
curl -fsSL https://typst.community/install | sh

2. Use the Project

# Clone the repository
git clone https://github.com/Vncntvx/modern-ucas-thesis.git
cd modern-ucas-thesis

# Compile the thesis
typst compile template/thesis.typ --root . --font-path fonts

# Compile the research proposal (shared entry for bachelor/master; see template/proposal.typ)
typst compile template/proposal.typ --root . --font-path fonts

# Or enable live preview
typst watch template/thesis.typ --root . --font-path fonts

3. Configure Thesis Information

Edit template/thesis.typ:

#import "../lib.typ": documentclass

#let (
  doc, preface, mainmatter, appendix,
  cover, decl-page, abstract, abstract-en,
  outline-page, list-of-figures-and-tables, notation,
  bilingual-bibliography, acknowledgement, backmatter,
  bifigure, bitable, continued-table, auto-table, aligned-equation,
) = documentclass(
  doctype: "doctor",       // "bachelor" | "master" | "doctor"
  degree: "academic",      // "academic" | "professional"
  anonymous: false,        // Blind-review mode
  twoside: true,           // Double-sided printing mode
  fontset: "mac",          // "windows" | "mac" | "fandol" | "adobe"
  info: (
    title: ("Thesis Title", "Optional Subtitle"),
    title-en: "Thesis Title",
    author: "San Zhang",
    author-en: "Zhang San",
    // Supervisors: a list of dicts (name:, title:, affiliation:); the first supervisor comes first
    supervisors: (
      (name: "Si Li", title: "Professor", affiliation: "Institute of XXX, Chinese Academy of Sciences"),
      (name: "Wu Wang", title: "Professor", affiliation: "Institute of XXX, Chinese Academy of Sciences"),
    ),
    supervisors-en: (
      (name: "Si Li", title: "Professor", affiliation: "Institute of XXX, Chinese Academy of Sciences"),
      (name: "Wu Wang", title: "Professor", affiliation: "Institute of XXX, Chinese Academy of Sciences"),
    ),
    department: "Institute of XXX, Chinese Academy of Sciences",
    major: "Management Science and Engineering",
    category: "Doctor of Management",
    submit-date: datetime(year: 2024, month: 6, day: 1),
  ),
  bibliography: bibliography.with("ref.bib"),
)

#show: doc
#cover()
#decl-page()
#show: preface
// Abstract, outline, notation list, ...
#show: mainmatter
// Main text, ...

Project Structure

modern-ucas-thesis/
├── template/              # Thesis and research proposal sources (template entry)
│   ├── thesis.typ        # Thesis main file
│   ├── proposal.typ      # Research-proposal main file
│   ├── ref.bib           # Bibliography (shared by the thesis and the proposal)
│   └── images/           # Image directory
├── pages/                # Page implementations (cover, declaration, abstract, outline, proposal, etc.)
├── layouts/              # Page-level layouts (doc / preface / mainmatter / appendix)
├── utils/                # Reusable utilities (bilingual figures/tables, continued tables, aligned equations, fonts, numbering, etc.)
├── assets/               # Static assets (UCAS visual identity, etc.)
├── fonts/                # Font directory (place font files yourself; see fonts/README.md)
├── docs/                 # Documentation (guideline texts, customization guide, FAQ, etc.)
├── lib.typ               # Main library entry (documentclass / proposalclass closure factories)
├── typst.toml            # Typst package manifest
└── Makefile              # Formatting and check scripts

Features

Implementation status is checked item by item against UCAS Graduate Thesis Writing Guidelines (2022) in docs/RULES-GRAD.md. Status legend: ✅ Completed | 🟡 Partial / needs polish | ❌ Not started | ➖ Not required by the guidelines.

Document Configuration

Cover and Front Matter

Main Text Typesetting

Figures and Tables

Equations and Math

References

Appendix and Back Matter

Fonts and Typesetting

Other Document Types

Documentation

• Graduate Writing Guidelines (Chinese) (UCAS Graduate Thesis Writing Guidelines, 2022)
• Undergraduate Writing Guidelines (Chinese) (UCAS Undergraduate Thesis (Design) Writing Guidelines, 2023-10 revision)
• Customization Guide
• FAQ
• Formatting Tools
• UCAS Logo Copyright

Development

# Format code (requires typstyle)
make format           # Format all .typ files
make format-check     # Check only, no writes; the CI gate
make lint-quick       # Check typst.toml fields and the entry point; no external index

Acknowledgements

• Built on modern-nju-thesis
• References the ucasthesis LaTeX template

License

The code of this project is open-sourced under the MIT License.

About the UCAS logo: The visual identity elements in the assets/vi/ directory, including the university emblem and logo, are copyrighted by the University of Chinese Academy of Sciences. They are included in this project solely for the convenience of users writing degree theses (within the scope of personal learning/teaching fair use). Do not use them for other commercial or official purposes. For commercial licensing, contact the relevant university departments. See LOGO_COPYRIGHT.md for details.

Report Issues · Discussions · Contribute