使用 typst 编写实验报告¶

typst 是一个新型的基于标记的轻量化排版系统，相较于安装复杂且体积庞大的 LaTex，typst 所需要的空间仅仅约 30M，安装方法也十分简单，下载对应的二进制文件，添加到系统路径即可。对于 IDE，推荐使用 VSCode，并安装 Typst LSP 插件实现实时预览。

关于 typst 的一些细节可以参考 typst doc，同时，推荐使用模板来撰写格式更加更为统一的实验报告，可以参考模板，后文给出了一个可能的使用方法。

使用示例¶

从文件管理开始¶

为了方便，我们从头开始，新建一个文件夹，专门用来进行实验报告的撰写。

本实验报告模板存放在本实验仓库的 templates 目录下，你可以通过 git clone 或者直接下载的方式将其下载到本地。

假设你本地已经克隆了一份模版，在 Unix 系统中使用 ln -s /path/to/the/template/repo base 创建一个名为 base 的软链接，目的是为了方便我们后续使用模板。操作成功后，你的目录结构应该类似于：

1
2

.
└── base -> ../template

考虑到可能有多个实验，推荐每个实验都新建一个文件夹，并创建对应的图片等目录，例如如下的结构

1
2
3
4
5
6

.
├── base -> ../template
└── lab-0
    ├── images
    │   └── linux.png
    └── example.typ

之后，在当前文件夹中打开终端或使用 VSCode，正常使用 typst 即可，例如：

编写报告¶

打开 example.typ，并输入：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

#import "../base/report.typ": *

#show: report.with(
  title: "实验报告实验",
  subtitle: "尝试使用 Typst 编写实验报告",
  name: "张三",
  stdid: "22223333",
  classid: "实验二班",
  major: "实验报告编写技术",
  school: "实验报告学院",
  time: "2022~2023 学年第二学期",
  banner: "../images/sysu.png"
)

如果安装了上文说的 Typst LSP 插件，那么此时应该能看到此时会自动生成一个 example.pdf，打开就能进行实时的预览。如果此时你没安装对应的字体的话，typst 会使用默认的字体来进行渲染，可能的话，请安装模板对应的字体。

标题¶

typst 在某些方面和 Markdown 有一定的相似之处，例如在 Markdown 中，我们使用 # 来表示标题，而在 typst 中，我们使用 = 来表示

即 Markdown 中的

1
2
3
4
5

# 一级标题

## 二级标题

### 三级标题

可以简单的转换为

1
2
3
4
5

= 一级标题

== 二级标题

=== 三级标题

代码块¶

代码块也是相似的，基本上和 Markdown 的语法一致

即下面的 Markdown 也能直接被 typst 识别

1
2
3
4
5
6
7
8

```c
#include <stdio.h>

int main() {
  printf("Hello World!\n");
  return 0;
}
```

字体修改¶

可以使用如下的方法

1

#text("Hello", font: "Times New Roman", size: 20pt, weight: "bold")

而对于加粗，还可以使用类似 Markdown 的 * 来括住需要强调

如果需要对大段文字字体进行修改，可以使用 #set 完成，这里不做展开

图像¶

对于图像，格式为

1

#image("/path/to/the/image")

对齐方式¶

1
2
3

#align(center)[
  这是一个居中样例
]

表格¶

以如下的表格为例：

可以使用如下的例子

1
2
3
4
5
6
7
8

#table(
  columns: (auto, auto, auto),
  align: center,
  [调度算法],[算法描述],[实验结果],
  [FCFS], [略], [略],
  [SSTF], [略], [略],
  [SCAN], [略], [略],
)

数学公式¶

数学公式使用 $ 括住即可，对于行间公式，在 $ 和内容间加上空格，例如

1

$ sum_(k=1)^n k = (n(n+1)) / 2 $

会被渲染成单独的一行：