Skip to main content

Module layout

Module layout 

Source
Expand description

Configurable on-disk issue layout ([layout] in tix.toml).

A directory template and a filename template, with {token} placeholders, decide where a new issue is written and (when move_on_change) where an existing one belongs after a templated value changes. The reader is layout-agnostic (crate::storage::Store::scan walks any depth), so a store can hold several layouts at once and migrate gradually.

Functionsยง

render
The store-relative path an issue belongs at, from the configured templates.
render_directory
The store-relative directory an issue belongs in, from the directory template.
validate
Validate both templates: known tokens only, a safe relative path, and (for the filename) a .md suffix. Called at config load so a bad template is refused before any file is touched.