Module
jinks/section
src/jinks/section.pookaCollection rules describe a shelf before any books arrive. They are kept apart from rendering so configuration never depends on a parsed page.
API reference
class Spec(
name: String,
path: String,
sort: String,
descending: Bool,
permalink: String,
defaults: tome.Toml
)
name: String
INFERRED
Stringpath: String
INFERRED
Stringsort: String
INFERRED
Stringdescending: Bool
INFERRED
Boolpermalink: String
INFERRED
Stringdefaults: tome.Toml
INFERRED
$package/tome/tome.Toml
INFERRED
fn(String, String, String, Bool, String, $package/tome/tome.Toml) -> jinks/section.Specparse(doc: tome.Toml) -> Result(List(Spec), String)
INFERRED
fn($package/tome/tome.Toml) -> Result(List(jinks/section.Spec), String)read(name: String, doc: tome.Toml) -> Result(Spec, String)
INFERRED
fn(String, $package/tome/tome.Toml) -> Result(jinks/section.Spec, String)valid_path(value: String) -> Bool
INFERRED
fn(String) -> Booltext(doc: tome.Toml, key: String, fallback: String) -> Result(String, String)
INFERRED
fn($package/tome/tome.Toml, String, String) -> Result(String, String)find(specs: List(Spec), name: String) -> Option(Spec)
INFERRED
fn(List(jinks/section.Spec), String) -> Option(jinks/section.Spec)The nearest matching directory wins; guides/advanced can specialise guides.