Module

jinks/config

src/jinks/config.pooka

Read the little card beside the front door. Paths belong to the site, rather than whichever directory happened to launch the command.

API reference

class

ServerOptions

src/jinks/config.pooka:18
class ServerOptions(host: String, port: Int, live_reload: Bool)
field

host

src/jinks/config.pooka:18
host: String
INFERREDString
field

port

src/jinks/config.pooka:18
port: Int
INFERREDInt
field

live_reload

src/jinks/config.pooka:18
live_reload: Bool
INFERREDBool
constructor

new

src/jinks/config.pooka:18
INFERREDfn(String, Int, Bool) -> jinks/config.ServerOptions
class

BuildOptions

src/jinks/config.pooka:20
class BuildOptions(drafts: Bool, future: Bool, environment: String)
field

drafts

src/jinks/config.pooka:20
drafts: Bool
INFERREDBool
field

future

src/jinks/config.pooka:20
future: Bool
INFERREDBool
field

environment

src/jinks/config.pooka:20
environment: String
INFERREDString
constructor

new

src/jinks/config.pooka:20
INFERREDfn(Bool, Bool, String) -> jinks/config.BuildOptions
class

Config

src/jinks/config.pooka:22
class Config(
  title: String,
  base_url: String,
  theme: String,
  output: String,
  params: json.Json,
  server: ServerOptions,
  collections: List(section.Spec),
  build: BuildOptions,
  listings: listing_options.Options,
  publishing: publishing_options.Options,
  raw_html: Bool
)
field

title

src/jinks/config.pooka:23
title: String
INFERREDString
field

base_url

src/jinks/config.pooka:24
base_url: String
INFERREDString
field

theme

src/jinks/config.pooka:25
theme: String
INFERREDString
field

output

src/jinks/config.pooka:26
output: String
INFERREDString
field

params

src/jinks/config.pooka:27
params: json.Json
INFERRED$package/pooka_json/pooka/json.Json
field

server

src/jinks/config.pooka:28
server: ServerOptions
field

collections

src/jinks/config.pooka:29
collections: List(section.Spec)
INFERREDList(jinks/section.Spec)
field

build

src/jinks/config.pooka:30
build: BuildOptions
field

listings

src/jinks/config.pooka:31
listings: listing_options.Options
field

publishing

src/jinks/config.pooka:32
publishing: publishing_options.Options
field

raw_html

src/jinks/config.pooka:33
raw_html: Bool
INFERREDBool
constructor

new

src/jinks/config.pooka:23
INFERREDfn(String, String, String, String, $package/pooka_json/pooka/json.Json, jinks/config.ServerOptions, List(jinks/section.Spec), jinks/config.BuildOptions, jinks/listing_options.Options, jinks/publishing_options.Options, Bool) -> jinks/config.Config
function

parse

src/jinks/config.pooka:42
parse(source: String) -> Result(Config, String)
INFERREDfn(String) -> Result(jinks/config.Config, String)

Missing optional settings have quiet defaults; malformed ones never do.

Pooka
let assert Ok(site) = config.parse("title = \"Owl\"")
assert site.theme == "minimal"
function

output_path

src/jinks/config.pooka:103
output_path(output: String) -> Result(Nil, String)
INFERREDfn(String) -> Result(Nil, String)

Shared by configuration and direct publication APIs, so callers cannot bypass source protection by constructing their own Config value.

function

text

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

relative

src/jinks/config.pooka:135
relative(value: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)

Keep generated paths beneath their owner, including on Windows.

function

server_options

src/jinks/config.pooka:152
server_options(doc: tome.Toml) -> Result(ServerOptions, String)
INFERREDfn($package/tome/tome.Toml) -> Result(jinks/config.ServerOptions, String)

Listener options are applied at serve startup. A live edit changes pages; changing host or port requires restarting the command.

function

with_params

src/jinks/config.pooka:188
with_params(site: Config, params: json.Json) -> Config
INFERREDfn(jinks/config.Config, $package/pooka_json/pooka/json.Json) -> jinks/config.Config
function

build_options

src/jinks/config.pooka:204
build_options(doc: tome.Toml) -> Result(BuildOptions, String)
INFERREDfn($package/tome/tome.Toml) -> Result(jinks/config.BuildOptions, String)
function

boolean

src/jinks/config.pooka:228
boolean(doc: tome.Toml, key: String, fallback: Bool) -> Result(Bool, String)
INFERREDfn($package/tome/tome.Toml, String, Bool) -> Result(Bool, String)
function

markdown_options

src/jinks/config.pooka:236
markdown_options(doc: tome.Toml) -> Result(Bool, String)
INFERREDfn($package/tome/tome.Toml) -> Result(Bool, String)