4个版本

0.11.1 2024年5月17日
0.11.0 2024年3月15日
0.11.0-rc12024年3月9日
0.1.0 2023年9月26日

#785 in 编程语言

Download history 73/week @ 2024-04-27 53/week @ 2024-05-04 153/week @ 2024-05-11 121/week @ 2024-05-18 120/week @ 2024-05-25 57/week @ 2024-06-01 78/week @ 2024-06-08 43/week @ 2024-06-15 30/week @ 2024-06-22 2/week @ 2024-06-29 61/week @ 2024-07-06 10/week @ 2024-07-13 1/week @ 2024-07-20 28/week @ 2024-07-27 22/week @ 2024-08-03 25/week @ 2024-08-10

每月76次下载

Apache-2.0

2.5MB
46K SLoC

Typst

Documentation Typst App Discord Server Apache-2 License Jobs at Typst

Typst是一个基于标记的排版系统,设计得既强大又易于学习和使用,就像LaTeX一样。Typst具有

  • 内置标记以处理最常见的格式化任务
  • 灵活的功能处理其他一切
  • 紧密集成的脚本系统
  • 数学排版、参考文献管理等等
  • 由于增量编译,编译时间快
  • 如果出现问题,将提供友好的错误信息

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

示例

我们文档中有Typst的温和介绍。但是,如果您想通过一个图像看到Typst的强大功能,请看这里

Example

让我们剖析一下发生了什么

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

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

  • 数学公式用美元符号括起来。通过在公式的内容周围添加额外的空格,我们可以将其放入单独的块中。除非加引号,否则多字母标识符被视为Typst定义和函数。这样,我们不需要反斜杠来表示像floorsqrt这样的内容。而且phi.altalt修饰符应用到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在Repology
    • macOS:brew install typst
    • Windows:winget install --id Typst.Typst
  • 如果您已安装Rust工具链,您也可以使用cargo install --git https://github.com/typst/typst --locked typst-cli安装最新的开发版本。请注意,这将是一个“夜间”版本,可能存在错误或尚未正确记录。

  • Nix用户可以使用nix-shell -p typst使用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体验,您也可以查看Typst Web应用程序,目前处于公开测试阶段。

社区

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

除此之外,还有一些地方您可以找到社区构建的内容

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

贡献

我们非常希望看到社区的贡献。如果您遇到错误,请随时提交一个问题。如果您想实现一个新功能或修复错误,请按照贡献指南中的步骤操作。

要自己构建Typst,首先请确保您已安装最新的稳定版Rust然后,克隆此存储库,并使用以下命令构建CLI:

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

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

贡献的另一种好方法是与社区分享包

发音和拼写

IPA:/taɪpst/。“Ty”像在= Introduction中的“Ty”,而“pst”像在Hi#heading[Introduction]中的“pst”。当写关于Typst时,将其名称作为专有名词首字母大写,即“T”。

设计原则

Typst的设计考虑了三个主要目标:力量、简洁性和性能。我们认为是时候有一个与LaTeX一样强大、易于学习和使用、同时足够快速以实现即时预览的系统了。为了实现这些目标,我们遵循以下三个核心设计原则

  • 一致性中的简洁性:如果您知道如何在Typst中做一件事,您应该能够将这种知识转移到其他事物上。如果有多种方法可以完成同一件事,其中之一应该比另一个在抽象级别上不同。例如,= Introduction#heading[Introduction]可以完成相同的事情,因为前者是后者的语法糖。

  • 组合性中的力量:有两种方法可以使事物灵活:为每件事提供一个旋钮,或者有少量旋钮可以以许多方式组合。Typst的设计考虑了第二种方法。我们提供您可以组合的系统,我们甚至从未想过。TeX也属于第二类,但它是低级的,因此人们使用LaTeX。但是,在那里,我们没有太多组合性。相反,每件事都有一个包(\usepackage{旋钮})。

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

依赖关系

~57MB
~805K SLoC