I made a Gradle plugin for Typst build automation

Showcase
1

Hi,

When I started to make a data-driven card game with Typst, my build setup became rather complex.

  • Multiple documents with different layouts
  • Variants of the same document for different purposes (web and printing)
  • Converting images to a supported format
  • Custom fonts
  • Keeping the project files well-structured and the build robust and portable
  • Deployment via CI

With a classical shell scripting approach, the build was very slow and redundant. So I decided to create and publish a Gradle plugin to build Typst documents managed in a Gradle project. Gradle is a build tool that can improve build time and stability of complex projects. It helps with platform-agnostic file handling, caching, incremental build and so much more what a build tool should do.

See on GitHub: GitHub - infolektuell/gradle-typst: Compile Typst documents using Gradle
See on Gradle Plugin Portal: Gradle - Plugin: de.infolektuell.typst
As a blind person, inserting gifs and screenshots is a bit difficult.

  • The plugin downloads and prepares the user-configured Typst version from GitHub releases or uses a local installation.
  • No command line arg fiddling, just ./gradlew build and go.
  • It compiles multiple documents in parallel to save more time.
  • Build steps re-run only if critical files were changed.
  • Optionally, it converts images using ImageMagick. This must be installed, if the feature is needed.
  • Local Typst packages can be watched.

If you think this could be useful, I can create some demo/template/sample projects.

4 Likes