4个版本

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

973编程语言

Download history 34/week @ 2024-05-03 45/week @ 2024-05-10 540/week @ 2024-05-17 297/week @ 2024-05-24 331/week @ 2024-05-31 260/week @ 2024-06-07 254/week @ 2024-06-14 275/week @ 2024-06-21 179/week @ 2024-06-28 264/week @ 2024-07-05 217/week @ 2024-07-12 264/week @ 2024-07-19 281/week @ 2024-07-26 290/week @ 2024-08-02 219/week @ 2024-08-09 188/week @ 2024-08-16

1,008每月下载量
2 crates中使用

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 gentle introduction。然而,如果您想通过一个图像看到Typst的全部力量,这里就是

Example

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

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

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

  • 数学公式用美元符号包围。通过在方程内容周围添加额外空格,我们可以将其放入单独的块中。多字母标识符在未引号中时被解释为Typst定义和函数。这样,我们就无需在floorsqrt等事物中使用反斜杠。而且phi.altalt修改器应用于phi以选择特定的符号变体。

  • 现在,我们进入一些脚本的介绍。要将代码输入到Typst文档中,我们可以写一个hash符号后跟一个表达式。我们定义了两个变量和一个递归函数来计算第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用户可以使用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创建的酷炫事物,或者只是聊天。

除此之外,您还可以在几个地方找到社区构建的内容

如果您在我们社区中有不愉快的经历,请联系我们

贡献

我们非常希望看到社区的贡献。如果您遇到错误,请随意打开一个问题。如果您想实现一个新功能或修复错误,请遵循贡献指南中概述的步骤。

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

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

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

向社区分享软件包也是贡献的好方法。

发音和拼写

IPA: /taɪpst/。 "Ty" 如在 Typesetting 中,"pst" 如在 Hipster 中。在撰写关于Typst时,将其名称作为专有名词大写,首字母大写。

设计原则

Typst的设计始终围绕三个关键目标:力量、简洁性和性能。我们认为,是时候有一个能够匹配LaTeX的强大系统,易于学习和使用,同时足够快,可以实现即时预览。为了实现这些目标,我们遵循以下三个核心设计原则:

  • 通过一致性实现简洁:如果您知道如何在Typst中完成一件事,您应该能够将这方面的知识应用到其他事物上。如果有多种方式完成同一件事,其中之一应该与另一个在抽象级别上不同。例如,= Introduction#heading[Introduction] 做了同一件事,因为前者只是后者的语法糖。

  • 通过可组合性实现力量:有两种方法可以使其灵活:为每件事都提供一个旋钮或有几个旋钮可以以多种方式组合。Typst的设计考虑了第二种方式。我们提供了您可以以我们从未想过的方式组合的系统。TeX也属于第二类,但它有点底层,因此人们使用LaTeX。但那里,我们实际上并没有那么多的可组合性。相反,每件事都有一个软件包(\usepackage{knob})。

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

依赖关系

~57MB
~805K SLoC