Typst 安装与使用教程
项目介绍
Typst 是一个新的基于标记的排版系统,旨在与 LaTeX 一样强大,同时更易于学习和使用。Typst 提供了内置的标记功能,用于最常见的排版需求。该项目 setup-typst
旨在帮助用户在 GitHub Actions 中安装和使用 Typst。
项目快速启动
安装 Typst
使用包管理器安装
-
Windows:
winget install --id Typst.Typst
-
Linux: 查看 Repology 获取安装命令。
-
macOS:
brew install typst
使用 Rust 工具链安装
如果你已经安装了 Rust 工具链,可以通过以下命令安装 Typst:
cargo install --locked typst-cli
在 GitHub Actions 中使用 Typst
以下是一个简单的 GitHub Actions 工作流配置,用于在推送时渲染 PDF:
name: Render paper.pdf
on: [push]
jobs:
render-paper:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: typst-community/setup-typst@v3
with:
cache-dependency-path: requirements.typ
- run: typst compile paper.typ paper.pdf
应用案例和最佳实践
自动重新编译
Typst 支持监视源文件并在更改时自动重新编译,这比手动编译更快:
typst watch path/to/source.typ path/to/output.pdf
使用 GitHub Actions 自动化
通过 GitHub Actions,你可以自动化文档的编译和部署过程。以下是一个完整的示例:
name: Build and Deploy
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: typst-community/setup-typst@v3
- run: typst compile paper.typ paper.pdf
- name: Deploy
uses: actions/upload-artifact@v3
with:
name: paper.pdf
path: paper.pdf
典型生态项目
Typst 社区
Typst 社区提供了多个与 Typst 相关的项目,包括插件、模板和工具。你可以访问 Typst 社区 GitHub 组织 获取更多资源。
Typst 插件
Typst 插件可以扩展 Typst 的功能,例如添加新的标记语言或自动化任务。你可以在 Typst 插件仓库 中找到和贡献插件。
通过这些资源,你可以更好地利用 Typst 进行文档排版和自动化工作流。