Skip to content

Commit 117ef0c

Browse files
committed
docs: add screenshots and more comments
1 parent 6af2ace commit 117ef0c

File tree

10 files changed

+14
-7
lines changed

10 files changed

+14
-7
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# ZJU-Project-Report-Template
22

3-
Typst is a new text markup language, considered the successor of LaTeX. This is yet another Zhejiang University project report template written in Typst, mainly designed for the course "Fundamentals of Data Structures (211C0020)".
3+
Typst is a new text markup language, considered the successor of LaTeX. This is yet another Zhejiang University project report template written in Typst, mainly designed for the course "Fundamentals of Data Structures (211C0020)" and "Digital Logic Design (211C0060)".
44

5-
**Reminder**: Due to course requirements, you are prohibited to disclose personal information in your submission. Use this project at your own risk.
5+
**Reminder**: Due to requirements of some specific courses, disclosing personal information is prohibited and will be punished. So use this project at your own risk.
66

77
## Configuration
88

99
### Theme
1010

1111
Currently, I have provided two themes, corresponding to common lab reports and project reports in ZJU's Computer Science courses.
1212

13+
| `theme: project` | `theme: lab` |
14+
| :---------------------------------: | :--------------------------------: |
15+
| ![](./screenshots/fds_report_1.png) | ![](./screenshots/dd_report_1.png) |
16+
| ![](./screenshots/fds_report_2.png) | ![](./screenshots/dd_report_2.png) |
17+
| ![](./screenshots/fds_report_3.png) | ![](./screenshots/dd_report_3.png) |
18+
1319
### Fonts
1420

1521
I have configured default fallback options for serif, sans-serif, and monospace fonts, which you can modify using the `font_serif`, `font_sans_serif`, and `font_mono` arguments.
1622

17-
However, for better rendering experiences, font family `New Computer Modern` and `Source Han Serif SC` are preferred.
23+
However, for better rendering experiences, Chineses font families that support arbitrary levels of font weight, such as [`Source Han Serif SC`](https://github.com/adobe-fonts/source-han-serif/releases/tag/2.002R), is recommanded.

examples/dd/report.typ

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#import "../../template.typ": *
22

33
#show: project.with(
4+
theme: "lab",
45
course: "数字逻辑设计",
56
title: "数字逻辑设计 实验报告",
67
semester: "2023-2024 Spring & Summer",
@@ -10,7 +11,6 @@
1011
college: "计算机科学与技术学院",
1112
major: "计算机科学与技术",
1213
teacher: "某老师",
13-
theme: "lab",
1414
)
1515

1616
#lab_header(name: "Lab1: 第一次实验", place: "紫金港 东x-xxx", date: "20xx年xx月xx日")

examples/fds/documents/report.typ

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#import "../../../template.typ": *
22

33
#show: project.with(
4+
theme: "project",
45
course: "Fundamentals of Data Structures",
56
title: "Projects 1: ???",
67
date: "2024/03/14",

screenshots/dd_report_1.png

73.3 KB
Loading

screenshots/dd_report_2.png

340 KB
Loading

screenshots/dd_report_3.png

225 KB
Loading

screenshots/fds_report_1.png

173 KB
Loading

screenshots/fds_report_2.png

72.9 KB
Loading

screenshots/fds_report_3.png

187 KB
Loading

template.typ

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
}
2424

2525
#let project(
26-
theme: "ds",
26+
theme: "project",
2727
course: "<course>",
2828
title: "<title>",
2929
title_size: 3em,
@@ -53,7 +53,7 @@
5353
if (language == none) {
5454
language = "cn"
5555
}
56-
} else if (theme == "ds") {
56+
} else if (theme == "project") {
5757
if (cover_image_size == none) {
5858
cover_image_size = 50%
5959
}
@@ -125,7 +125,7 @@
125125
])
126126
v(2fr)
127127
pagebreak()
128-
} else if (theme == "ds") {
128+
} else if (theme == "project") {
129129
v(1fr)
130130
box(
131131
width: 100%,

0 commit comments

Comments
 (0)