4个版本

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

18#everything 排名中

Download history 238/week @ 2024-05-04 403/week @ 2024-05-11 1075/week @ 2024-05-18 750/week @ 2024-05-25 604/week @ 2024-06-01 895/week @ 2024-06-08 874/week @ 2024-06-15 642/week @ 2024-06-22 622/week @ 2024-06-29 666/week @ 2024-07-06 700/week @ 2024-07-13 740/week @ 2024-07-20 659/week @ 2024-07-27 637/week @ 2024-08-03 698/week @ 2024-08-10 576/week @ 2024-08-17

2,630 每月下载量
27 个crate(6个直接) 中使用

Apache-2.0

100KB
2K SLoC

Typst

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

Typst是一个基于标记的排版系统,它旨在具有与LaTeX相当的功能,同时学习和使用起来更容易。Typst具有

  • 内置的标记用于最常见的格式化任务
  • 灵活的函数用于其他所有内容
  • 紧密集成的脚本系统
  • 数学排版、参考文献管理等等
  • 由于增量编译,编译速度快
  • 如果出现问题,有友好的错误信息

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

示例

我们文档中提供了对Typst的温和介绍。然而,如果您想通过一张图片看到Typst的强大功能,这里就是

Example

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

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

  • 我们使用= 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 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 类似体验,包括自动完成和即时预览,您还可以检查 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 的内容时,请将其名称作为专有名词大写,首字母大写 "T"。

设计原则

Typst 的所有设计都是基于三个关键目标:强大、简单和性能。我们认为是时候有一个系统,它的功能与 LaTeX 相当,易于学习和使用,同时足够快,可以实现即时预览。为了实现这些目标,我们遵循三个核心设计原则

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

  • 通过可组合性带来强大:有两种方式可以使其灵活:为每件事都提供一个旋钮或提供一些旋钮,您可以用多种方式组合它们。Typst 是基于第二种方式设计的。我们提供您可以组合的系统,我们可以以我们从未想过的方式组合它们。TeX 也属于第二类,但它稍微低级一些,因此人们使用 LaTeX。但那里,我们实际上并没有那么多的可组合性。相反,每件事都有一个包(\usepackage{knob})。

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

依赖关系

~315–770KB
~18K SLoC