5 个版本
0.11.1 | 2024年5月17日 |
---|---|
0.11.0 | 2024年3月15日 |
0.11.0-rc1 | 2024年3月9日 |
0.1.1 | 2023年6月8日 |
0.1.0 | 2023年3月21日 |
#13 in 编程语言
2,724 每月下载量
用于 27 个crate(26个直接使用)
2.5MB
51K SLoC
Typst是一款新的基于标记的排版系统,旨在提供与LaTeX相当的功能,同时易于学习和使用。Typst具有:
- 内置标记,用于最常见的格式化任务
- 灵活的功能,用于其他一切
- 紧密集成的脚本系统
- 数学排版、参考文献管理等功能
- 由于增量编译而拥有快速的编译时间
- 在出错时提供友好的错误信息
此仓库包含Typst编译器和其命令行界面,这是您在本地编译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仓库
如果您在我们的社区中遇到了不好的体验,请联系我们。
贡献
我们非常欢迎社区成员的贡献。如果您遇到错误,请随意打开一个issue。如果您想实现新功能或修复错误,请按照贡献指南中的步骤操作。
要自己构建Typst,首先确保您已安装了最新稳定的Rust。然后,克隆此仓库并使用以下命令构建CLI
git clone https://github.com/typst/typst
cd typst
cargo build --release
优化后的二进制文件将存储在target/release/
。
另一种贡献方式是与社区分享包。
发音和拼写
IPA: /taɪpst/。“Ty”类似于单词Typesteting中的“Ty”,“pst”类似于单词Hipster。在撰写关于Typst的文章时,请将其名称作为专有名词首字母大写,即“Typst”。
设计原则
Typst的所有设计都是基于三个核心目标进行的:力量、简洁性和性能。我们认为是时候有一个能够匹配LaTeX的力量、易于学习和使用、同时足够快速实现即时预览的系统了。为了实现这些目标,我们遵循三个核心设计原则
-
通过一致性实现简洁:如果您知道如何在Typst中完成一项任务,您应该能够将这项知识应用到其他事物上。如果有多种方法完成同一件事,其中一种方法应该比另一种方法抽象程度更高。例如,
= Introduction
和#heading[Introduction]
完成同一件事,因为前者只是后者的语法糖。 -
通过组合性实现力量:有两种方法可以使某物灵活:为每一件事都提供一个旋钮,或者提供一些可以以多种方式组合的旋钮。Typst的设计理念是后者。我们提供了可以以我们从未想过的方式组合的系统。TeX也属于第二类,但它稍微低级一些,因此人们使用LaTeX。但那里,我们并没有那么多的组合性。相反,每个东西都有一个包(
\usepackage{knob
)。 -
增量编译:所有Typst语言特性都必须适应增量编译。幸运的是,我们有
comemo
,这是一个增量编译系统,它会在后台完成大部分工作。
依赖项
~57MB
~799K SLoC