Getting started

The easiest way to get started with a rookery is by installing Rheo, a typesetting engine based on Typst. Once you have rheo on your path, scaffold a new Rheo project:

rheo init my_rookery
cd my_rookery

Add the following section to the rheo.toml configuration file at the root of the my_rookery project:

[packages.rookery]
releases = "freecomputinglab/rookery"

This allows Rheo to discover the rookery packages. Rheo has a built-in development server which will incrementally update your browser as you edit source files:

rheo watch . --html --open

Once this is running, you are all ready to hatch your first idea. Do so in index.typ (or create a new file if you prefer):

#import "@rookery/core:0.1.0": idea
#idea[I want to hatch ideas with rookery.]

You’re all set! Your rookery is now ready to nurture your every next idea.