setup-tinytex

This action sets up TinyTeX by:

downloading TinyTeX and adding it to the PATH

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v4
- uses: r-lib/actions/setup-tinytex@v2
- run: tlmgr --version

If you want to select the CTAN mirror you can set the CTAN_REPO tinytex environment variable.

CTAN packages

The tinytex R package (which is not the same as the TinyTeX TeX distribution) supports automatic CTAN package installation when using the rmarkdown package. If you are using TinyTeX without rmarkdown (including using it without R!), then you will need to install CTAN packages manually. For example this is the case if your R package builds its PDF reference manual at R CMD build or while being checked.

To install CTAN packages manually, you can call tlmgr from your workflow. We suggest you also run tlmgr update --self before installing, otherwise the installation may fail. Here is a complete example:

steps:
  - uses: actions/checkout@v4
  - uses: r-lib/actions/setup-tinytex@v2
  - run: tlmgr --version

  - name: Install additional LaTeX packages
    run: |
      tlmgr update --self
      tlmgr install titlesec
      tlmgr list --only-installed

TinyTeX bundled release

TinyTeX is available as several bundles from https://github.com/rstudio/tinytex-releases/.

By default, the action will install the same bundle as tinytex::install_tinytex() which is the daily build of TinyTeX-1 bundle. This bundles contains the TinyTeX distribution and a set of CTAN packages. The TinyTeX bundles comes with more CTAN packages bundled.

To change the bundle to install you can change the environment variable TINYTEX_INSTALLER

      - uses: r-lib/actions/setup-tinytex@v2
        env:
          # install full prebuilt version
          TINYTEX_INSTALLER: TinyTeX

In addition to the daily commonly used, TinyTeX is also built in monthly releases. You can find all the releases in https://github.com/rstudio/tinytex-releases/releases

To install a specific version, you can set the TINYTEX_VERSION environment variable

      - uses: r-lib/actions/setup-tinytex@v2
        env:
          # always install the bundled version from Nov. 2021
          TINYTEX_VERSION: 2021.11

See more on those bundles in rstudio/tinytex-releases README, especially the list of bundled CTAN packages.

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome! See Contributor's Guide

Sunbelt Computer Software

PL/B Language Development and Support