Module

jinks/section

src/jinks/section.pooka

Collection 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

src/jinks/section.pooka:11
class Spec(
  name: String,
  path: String,
  sort: String,
  descending: Bool,
  permalink: String,
  defaults: tome.Toml
)
field

name

src/jinks/section.pooka:12
name: String
INFERREDString
field

path

src/jinks/section.pooka:13
path: String
INFERREDString
field

sort

src/jinks/section.pooka:14
sort: String
INFERREDString
field

descending

src/jinks/section.pooka:15
descending: Bool
INFERREDBool
field

permalink

src/jinks/section.pooka:16
permalink: String
INFERREDString
field

defaults

src/jinks/section.pooka:17
defaults: tome.Toml
INFERRED$package/tome/tome.Toml
constructor

new

src/jinks/section.pooka:12
INFERREDfn(String, String, String, Bool, String, $package/tome/tome.Toml) -> jinks/section.Spec
function

parse

src/jinks/section.pooka:20
parse(doc: tome.Toml) -> Result(List(Spec), String)
INFERREDfn($package/tome/tome.Toml) -> Result(List(jinks/section.Spec), String)
function

read

src/jinks/section.pooka:38
read(name: String, doc: tome.Toml) -> Result(Spec, String)
INFERREDfn(String, $package/tome/tome.Toml) -> Result(jinks/section.Spec, String)
function

valid_path

src/jinks/section.pooka:110
valid_path(value: String) -> Bool
INFERREDfn(String) -> Bool
function

text

src/jinks/section.pooka:119
text(doc: tome.Toml, key: String, fallback: String) -> Result(String, String)
INFERREDfn($package/tome/tome.Toml, String, String) -> Result(String, String)
function

find

src/jinks/section.pooka:128
find(specs: List(Spec), name: String) -> Option(Spec)
INFERREDfn(List(jinks/section.Spec), String) -> Option(jinks/section.Spec)

The nearest matching directory wins; guides/advanced can specialise guides.