[idea:using-typst]faq2026-08-20

Do I need to use Rheo to use rookery?

Rheo is a typesetting engine based on Typst that is also maintained at the Free Computing Lab. In addition to providing an EPUB export option, Rheo can also register custom JavaScript and CSS from a package such as rookery.

While we make a best effort to keep the rookery package Typst-native, we can guarantee a better experience if you compile your rookeries with Rheo. A large part of this is because rookery’s implementation depends heavily on Typst’s experimental bundle export, which means that one needs various flags and specific configuration to compile a rookery with the Typst CLI.

Using pure Typst, your rookeries will certainly not get standalone minted idea pages, rookery-wide outlines, and the ability to compile to EPUB, and idea-href will always be none. Other aspects of the rookery may also not work. Using the latest release of Rheo, by contrast, rookery should work out of the box.