【Typst源文件】 Typst 文件格式完全总结

一、名称由来与读音1. 名称由来Typst 的名称来源于其开发语言与核心领域的结合Typ取自Typesetting排版点明项目的核心定位st源自Rust表示项目使用 Rust 语言编写这个名字也象征着它兼具 Rust 的高性能与现代化的排版体验旨在解决 LaTeX 臃肿、编译慢的痛点。2. 读音Typst 通常读作/taɪpst/近似中文发音“泰普斯特”。Typ读作 /taɪp/泰普与单词type发音相同st源于Rust/rʌst/取其中的 /st/斯特音社区中也有少数人会按字母逐字读作 “T-Y-P-S-T”但官方及大多数用户倾向于将其作为一个单词连读。二、什么是.typ格式.typ是Typst排版系统的源文件扩展名。Typst 是一个现代化的文档排版工具定位介于 Markdown过于简单和 LaTeX过于复杂之间旨在提供简洁语法 强大功能的平衡方案。三、文件命名规范规则说明扩展名必须使用.typ如main.typ、report.typ允许字符字母、数字、连字符-、下划线_建议字母或下划线开头推荐命名主文件用main.typ包入口用lib.typ依赖管理用libs.typ命名风格模块导入建议使用kebab-case如my-module.typ注意事项输出 PDF 文件名需通过 CLI 指定中文文件名可能在某些工具链中存在问题四、语法本质混合模式设计Typst 采用标记模式 脚本模式的混合语法标记模式类似 Markdown用于快速书写内容标题、列表、强调等脚本模式类似Rust Python的混合风格用于编程控制变量、条件、循环、函数等切换方式用#前缀从标记模式切换到代码模式语法特征来源影响来源体现Rust#前缀、模块系统import、闭包语法(x) { ... }Python列表推导、简洁的变量绑定、元组/字典字面量Markdown标题、*粗体、-列表等标记语法LaTeX$...$数学模式但用函数式 API 替代繁琐命令五、主要用途与场景1.学术论文与技术文档数学公式支持$x^2$、$(ab)/2$自动编号#set heading(numbering: 1.1)参考文献#bibliography(refs.bib)图表编号#figure(image(chart.svg), caption: [说明])2.书籍与长文档排版模块化组织import chapter.typ、include intro.typ全局样式控制#set text(font: ..., size: 11pt)页面设置#set page(paper: a4, margin: ...)3.报告与演示文稿快速输出 PDF条件内容#if condition [内容]循环生成内容#for i in range(3)[#i]4.可复用的模板与包定义模板文件lib.typ作为包入口函数封装#let my-template (body) { ... }跨项目共享样式5.配置与依赖管理集中导入imports.typ管理所有包依赖类似requirements.txt的依赖文件六、核心语法速览基础标记 一级标题 二级标题 *粗体* _斜体_ - 无序列表 有序列表 代码 // 行内代码数学公式$x^2$ // 行内 $ x^2 $ // 块级 $(ab)/2$ // 分数 $x_1^2$ // 上下标脚本控制#let x 10 // 变量 #let add (a, b) a b // 函数 #if x 0 [正数] else [负数] // 条件 #for i in range(3)[#i] // 循环 import lib.typ // 导入样式设置#set text(font: New Computer Modern, size: 11pt) #set page(paper: a4, margin: (x: 2cm, y: 2.5cm)) #set par(justify: true)七、编辑器支持Typst 拥有丰富的编辑器和工具支持满足不同场景的开发需求1.官方编辑器编辑器说明Typst Web App官方在线编辑器实时预览、自动保存、云端同步适合快速上手和协作Typst CLI命令行工具支持本地编译和实时监听适合集成到自动化工作流2.VS Code 扩展扩展名称功能特点Typst LSP官方语言服务器提供语法高亮、错误提示、自动补全、悬停文档Typst Preview实时预览面板支持双向同步定位点击预览跳转到源码Typst Companion模板管理、代码片段、快捷编译3.其他编辑器插件编辑器插件名称功能说明Vim / Neovimtypst.vim、nvim-treesitter语法高亮、LSP 集成、Tree-sitter 解析Emacstypst-ts-mode语法高亮、编译支持、预览集成Sublime TextTypst包语法高亮、构建系统JetBrains IDEsTypst插件语法支持、编译运行IntelliJ、PyCharm 等Zed内置支持原生支持 Typst 语法高亮和 LSP4.在线与云端工具工具说明Typst Web App官方在线编辑器无需安装支持多人协作Overleaf 替代部分第三方平台开始集成 Typst 支持GitHub Actions可配置 CI/CD 自动编译.typ文件并发布 PDF5.辅助工具工具用途Typstfmt代码格式化工具自动规范排版Typst LSP语言服务器为各类编辑器提供智能提示Tinymist高性能 LSP 实现提供更快的分析和补全八、优势总结优势说明语法简洁类似 Markdown 的学习曲线但功能更强大编程能力支持变量、条件、循环、函数满足复杂排版需求编译速度快比 LaTeX 快数倍适合大型文档现代化内置智能引号、Unicode 支持、现代化错误提示模块化良好的导入系统便于组织和复用代码免费开源无需付费社区活跃编辑器生态主流编辑器均有支持开箱即用九、适用人群学生/研究人员写论文、作业、技术报告开发者写技术文档、API 文档出版者排版书籍、杂志教师制作讲义、课件任何需要高质量 PDF 输出的人总结.typ格式是 Typst 的核心文件格式它结合了Markdown 的简洁性、LaTeX 的排版能力和现代编程语言的表达力为文档排版提供了一个“恰到好处的抽象”——既不会像 Markdown 那样功能受限也不会像 LaTeX 那样语法繁琐。配合日益完善的编辑器生态Typst 已成为高效文档排版的理想选择。