Typst是一个基于标记的排版系统，旨在提供与LaTeX相当的功能，同时学习使用更加简单。Typst具有以下特性：

• 内置标记以处理最常见的格式化任务
• 灵活的功能用于其他所有任务
• 紧密集成的脚本系统
• 数学排版、文献管理等功能
• 得益于增量编译，编译速度更快
• 当出错时，提供友好的错误信息

此仓库包含Typst编译器和其CLI，这是本地编译Typst文档所需的所有内容。为了获得最佳写作体验，请考虑免费注册我们的协作在线编辑器。目前处于公共测试版。

示例

在我们的文档中提供了对Typst的温和介绍。但是，如果您想看到Typst在一个图像中展现的力量，请看这里

让我们来分析一下正在发生的事情

• 我们使用设置规则来配置元素属性，如页面大小或标题的编号。通过将页面高度设置为auto，它将根据内容进行缩放。设置规则可以适应最常见的配置。如果您需要完全控制，您还可以使用显示规则来完全重新定义元素的外观。

• 我们使用= Heading语法插入标题。一个等于号创建顶级标题，两个等于号创建子标题，以此类推。Typst具有更多类似这样的轻量级标记，请参阅语法参考以获取完整列表。

• 数学公式被美元符号包围。通过在方程内容的周围添加额外空格，我们可以将其放入单独的块中。除非被引号包围，否则多字母标识符被视为Typst定义和函数。这样，我们就不需要为诸如 floor 和 sqrt 这样的内容使用反斜杠。而且 phi.alt 将 alt 修饰符应用于 phi 以选择特定的符号变体。

• 现在，我们来谈谈一些 脚本。要将代码输入到Typst文档中，我们可以在表达式前写一个哈希符号。我们定义了两个变量和一个递归函数来计算第n个斐波那契数。然后，我们在居中对齐的表格中显示结果。表格函数按行接受其单元格。因此，我们首先将公式 $F_1$ 到 $F_8$，然后是计算出的斐波那契数。我们应用扩展运算符（..）到它们，因为它们是数组，我们希望将数组的项目作为单独的参数传递。

#set page(width: 10cm, height: auto)
#set heading(numbering: "1.")

= Fibonacci sequence
The Fibonacci sequence is defined through the
recurrence relation $F_n = F_(n-1) + F_(n-2)$.
It can also be expressed in _closed form:_

$ F_n = round(1 / sqrt(5) phi.alt^n), quad
  phi.alt = (1 + sqrt(5)) / 2 $

#let count = 8
#let nums = range(1, count + 1)
#let fib(n) = (
  if n <= 2 { 1 }
  else { fib(n - 1) + fib(n - 2) }
)

The first #count numbers of the sequence are:

#align(center, table(
  columns: count,
  ..nums.map(n => $F_#n$),
  ..nums.map(n => str(fib(n))),
))

安装

Typst的CLI可以从不同的来源获取

• 您可以从 发布页面 获取Typst的最新版本的源代码和预构建的二进制文件。下载适合您平台的存档并将其放置在您的 PATH 目录中。要了解未来的发布情况，您可以简单地运行 typst update。

• 您可以通过不同的包管理器安装Typst。请注意，包管理器中的版本可能落后于最新版本。

  • Linux：查看 Typst on Repology
  • macOS：brew install typst
  • Windows：winget install --id Typst.Typst

• 如果您已安装Rust工具链，您也可以使用 cargo install --git https://github.com/typst/typst --locked typst-cli 安装最新开发版本。请注意，这将是一个“夜间”版本，可能存在损坏或尚未适当记录的问题。

• Nix用户可以使用 typst 包，通过 nix-shell -p typst 或使用 nix run github:typst/typst -- --version 构建和运行最新的边缘版本。

• Docker用户可以使用 docker run -it ghcr.io/typst/typst:latest 运行预构建的镜像。

用法

安装Typst后，您可以像这样使用它

# Creates `file.pdf` in working directory.
typst compile file.typ

# Creates PDF file at the desired path.
typst compile path/to/source.typ path/to/output.pdf

您还可以监视源文件，并在更改时自动重新编译。这比每次从头开始编译要快，因为Typst具有增量编译。

# Watches source files and recompiles on changes.
typst watch file.typ

Typst还允许您为您的项目添加自定义字体路径，并列出它发现的全部字体

# Adds additional directories to search for fonts.
typst compile --font-path path/to/fonts file.typ

# Lists all of the discovered fonts in the system and the given directory.
typst fonts --font-path path/to/fonts

# Or via environment variable (Linux syntax).
TYPST_FONT_PATHS=path/to/fonts typst fonts

有关其他CLI子命令和选项，请参阅下文。

# Prints available subcommands and options.
typst help

# Prints detailed usage of a subcommand.
typst help watch

如果您喜欢集成IDE-like体验，包括自动完成和即时预览，您还可以查看Typst网络应用程序，目前处于公开测试阶段。

社区

社区聚集的主要地方是我们的Discord服务器。您可以在那里提问、帮助他人、分享您用Typst创建的酷东西，或者只是聊天。

除此之外，还有一些地方您可以找到社区制作的资源。

• 官方软件包列表
• Awesome Typst仓库

如果您在我们的社区中遇到了不好的体验，请联系我们。

贡献

我们非常希望看到社区的贡献。如果您遇到错误，请自由地打开一个问题。如果您想实现新功能或错误修复，请按照贡献指南中概述的步骤进行。

要自行构建Typst，首先请确保您已安装最新的稳定版Rust Rust。然后，克隆此仓库并使用以下命令构建CLI：

git clone https://github.com/typst/typst
cd typst
cargo build --release

优化后的二进制文件将存储在target/release/。

另一种很好的贡献方式是通过与社区分享软件包。

发音和拼写

IPA: /taɪpst/。"Ty" 类似于 Typesetting，"pst" 类似于 Hipster。在撰写有关Typst的文章时，请将名称视为专有名词，并使用大写 "T"。

设计原则

Typst的所有设计都是基于三个关键目标：力量、简单性和性能。我们认为现在是时候有一个能够匹配LaTeX的力量，易于学习和使用，同时足够快以实现即时预览的系统。为了实现这些目标，我们遵循三个核心设计原则

• 通过一致性实现简单性：如果您知道如何在Typst中做一件事，您应该能够将这项知识应用到其他事物上。如果有多种方法做同样的事情，其中一种方法应该比另一种方法具有不同的抽象级别。例如，= Introduction 和 #heading[Introduction] 做同样的事情，因为前者只是后者的语法糖。

• 通过可组合性实现力量：有两种方法可以使事物灵活：为每一件事都提供一个旋钮或提供几个旋钮，您可以将它们以多种方式组合。Typst的设计考虑了第二种方法。我们提供您可以以我们从未想过的方式组合的系统。TeX也属于这一类别，但它是低级别的，因此人们使用LaTeX。但是，在那里，我们并没有那么多的可组合性。相反，每件事都有一个软件包（\usepackage{旋钮}）。

• 通过增量实现性能：所有Typst语言功能都必须适应增量编译。幸运的是，我们有一个comemo系统，用于增量编译，它在后台完成了大部分艰苦的工作。