Module
jinks/build
src/jinks/build.pookaDiscover and render everything before writing a page. A broken template should not replace yesterday's readable work with half of today's work. An owned-file manifest and staged publication carry the previous site through write failures while removing only stale generated files.
API reference
class Output(name: String, text: String)
name: String
INFERRED
Stringtext: String
INFERRED
String
INFERRED
fn(String, String) -> jinks/build.Outputclass Asset(name: String, source: String)
name: String
INFERRED
Stringsource: String
INFERRED
String
INFERRED
fn(String, String) -> jinks/build.Assetprepare(root: String) -> Result(#(config.Config, List(Output)), String)
INFERRED
fn(String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)prepare_at(root: String, today: String) -> Result(
#(config.Config, List(Output)),
String
)
INFERRED
fn(String, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)The build observes one UTC publication day. Tests can supply that day without borrowing the wall clock or changing process-wide state.
prepare_selected(selected: request.Request) -> Result(
#(config.Config, List(Output)),
String
)
INFERRED
fn(jinks/request.Request) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)prepare_request(selected: request.Request, today: String) -> Result(
#(config.Config, List(Output)),
String
)
INFERRED
fn(jinks/request.Request, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)prepare_timed(selected: request.Request, clock: String) -> Result(
#(config.Config, List(Output)),
String
)
INFERRED
fn(jinks/request.Request, String) -> Result(#(jinks/config.Config, List(jinks/build.Output)), String)run(root: String) -> Result(Int, String)
INFERRED
fn(String) -> Result(Int, String)run_report(root: String) -> Result(#(config.Config, Int), String)
INFERRED
fn(String) -> Result(#(jinks/config.Config, Int), String)Return the settings used by this publication so a watcher never guesses the output directory from a second, potentially newer configuration read.
run_selected(selected: request.Request) -> Result(#(config.Config, Int), String)
INFERRED
fn(jinks/request.Request) -> Result(#(jinks/config.Config, Int), String)assets(root: String, settings: config.Config) -> Result(List(Asset), String)
INFERRED
fn(String, jinks/config.Config) -> Result(List(jinks/build.Asset), String)Site assets replace theme assets by relative path, preserving binary bytes.
asset_files(root: String) -> Result(List(Asset), String)
INFERRED
fn(String) -> Result(List(jinks/build.Asset), String)fingerprint(bytes: BitArray, done: List(String)) -> String
INFERRED
fn(BitArray, List(String)) -> Stringcheck_selected(selected: request.Request) -> Result(Nil, String)
INFERRED
fn(jinks/request.Request) -> Result(Nil, String)