Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 2.87 KB

README.md

File metadata and controls

96 lines (73 loc) · 2.87 KB
Raw

Setup Typst

This action provides the following functionality for GitHub Actions users:

  • Installing a version of Typst and adding it to the PATH
  • Optionally caching packages dependencies
- uses: typst-community/setup-typst@v3
- run: typst compile paper.typ paper.pdf

Usage

GitHub Actions GitHub

Basic usage

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
      # Now Typst is installed and packages will be cached!
      - run: typst compile paper.typ paper.pdf

Inputs

  • typst-token: The GitHub token to use when pulling versions from typst/typst. By default this should cover all cases. You shouldn't have to touch this setting.
  • typst-version: The version of Typst to install. This can be an exact version like 0.10.0 or a semver range like 0.10 or 0.x. You can also specify latest to always use the latest version. The default is latest.
  • cache-dependency-path: Used to specify the path to dependency file. Supports a Typst file with lines of import keyword.

Outputs

  • typst-version: The version of Typst that was installed. This will be something like 0.10.0 or similar.
  • cache-hit: Whether or not Typst was restored from the runner's cache or download anew.

Custom combinations

Uploading workflow artifact

- uses: typst-community/setup-typst@v3
  with:
    cache-dependency-path: requirements.typ
- run: typst compile paper.typ paper.pdf
- uses: actions/upload-artifact@v4
  with:
    name: paper
    path: paper.pdf

Expanding font support with Fontist

If your tasks require extending beyond the set of fonts in GitHub Actions runner, you can employ the Fontist to facilitate custom font installations. Here's an example showcasing how to use [fontist/setup-fontist] to add new fonts:

- uses: fontist/setup-fontist@v2
- run: fontist install "Fira Code"
- uses: typst-community/setup-typst@v3
  with:
    cache-dependency-path: requirements.typ
- run: typst compile paper.typ paper.pdf --font-path ~/.fontist/fonts

Development

Node.js

How do I test my changes?

Open a draft Pull Request and some magic GitHub Actions will run to test the action.