typst-community/Setup Typst
📑 Install Typst and add it to the PATH with package management
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| typst-version | Version range or exact version of Typst to use, using SemVer's version range syntax. Uses the latest version if unset. | — | latest |
| allow-prereleases | When 'true', a version range including 'latest' passed to 'typst-version' input will match prerelease versions. | — | false |
| executable-name | Used to specify the executable file name of Typst. | — | typst |
| typst-versions-file | Used to specify a path to a configuration file (JSON, HJSON, YAML, TOML, XML, INI, or HCL) mapping executable names to Typst version configurations, for installing multiple Typst versions at once. The format is detected automatically from the file extension. | no | — |
| typst-versions-json | Used to specify a JSON map of executable names to Typst version configurations. | no | — |
| typst-versions-hjson | Used to specify a HJSON map of executable names to Typst version configurations. | no | — |
| typst-versions-yaml | Used to specify a YAML map of executable names to Typst version configurations. | no | — |
| typst-versions-toml | Used to specify a TOML map of executable names to Typst version configurations. | no | — |
| typst-versions-xml | Used to specify an XML document mapping executable names to Typst version configurations. | no | — |
| typst-versions-ini | Used to specify an INI document mapping executable names to Typst version configurations. | no | — |
| typst-versions-hcl | Used to specify an HCL document mapping executable names to Typst version configurations. | no | — |
| typst-versions-map | [Deprecated] Used to specify a JSON map of executable names to Typst version configurations, for installing multiple Typst versions at once. | no | — |
| cache-dependency-path | Used to specify the path to a Typst file containing lines of 'import' keyword. | no | — |
| zip-packages | Used to specify the path to a JSON file containing names and ZIP archive URLs of packages. | no | — |
| cache-local-packages | When 'true', local packages set by 'zip-packages' will be cached independently of '@preview' packages. | — | false |
| token | The token used to authenticate when fetching Typst distributions from typst/typst. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | — | ${{ github.server_url == 'https://github.com' && github.token || '' }} |
Outputs
no outputs