Skip to content

Home

Jump to bottom
Andreas Kröpelin edited this page Jul 7, 2024 · 6 revisions

logo

Note

This wiki is incomplete so far, unfortunately.

Welcome to the Jlyfish wiki!

Jlyfish is a package for Typst and Julia that allows interoperation between the two. You can write Julia code directly inside your Typst source and it will be displayed as the result of the code in the final document.

There are three parts that work together to make this possible:

  1. The Typst package jlyfish. It provides functions that annotate your given Julia code with the necessary metadata such that the Julia side can query these information. It also takes care of displaying the results.
  2. The Julia package TypstJlyfish. It is used rather as an executable than as a library and provides the two functions watch and compile that, given a Typst source file, query it for Julia code, execute it, find the most appropriate way to display the results, and finally write the computed data into a JSON file.
  3. A project specific JSON file. It stores the results of the computations done in Julia and is read by the Typst package in order to display these results.
Clone this wiki locally