Module
jinks/config
src/jinks/config.pookaRead 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(host: String, port: Int, live_reload: Bool)
host: String
INFERRED
Stringport: Int
INFERRED
Intlive_reload: Bool
INFERRED
Bool
INFERRED
fn(String, Int, Bool) -> jinks/config.ServerOptionsclass BuildOptions(drafts: Bool, future: Bool, environment: String)
drafts: Bool
INFERRED
Boolfuture: Bool
INFERRED
Boolenvironment: String
INFERRED
String
INFERRED
fn(Bool, Bool, String) -> jinks/config.BuildOptionsclass 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
)
title: String
INFERRED
Stringbase_url: String
INFERRED
Stringtheme: String
INFERRED
Stringoutput: String
INFERRED
Stringparams: json.Json
INFERRED
$package/pooka_json/pooka/json.Jsonserver: ServerOptions
INFERRED
jinks/config.ServerOptionscollections: List(section.Spec)
INFERRED
List(jinks/section.Spec)build: BuildOptions
INFERRED
jinks/config.BuildOptionslistings: listing_options.Options
INFERRED
jinks/listing_options.Optionspublishing: publishing_options.Options
INFERRED
jinks/publishing_options.Optionsraw_html: Bool
INFERRED
Bool
INFERRED
fn(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.Configparse(source: String) -> Result(Config, String)
INFERRED
fn(String) -> Result(jinks/config.Config, String)Missing optional settings have quiet defaults; malformed ones never do.
let assert Ok(site) = config.parse("title = \"Owl\"")
assert site.theme == "minimal"
output_path(output: String) -> Result(Nil, String)
INFERRED
fn(String) -> Result(Nil, String)Shared by configuration and direct publication APIs, so callers cannot bypass source protection by constructing their own Config value.
text(doc: tome.Toml, key: String, fallback: String) -> Result(String, String)
INFERRED
fn($package/tome/tome.Toml, String, String) -> Result(String, String)relative(value: String) -> Result(String, String)
INFERRED
fn(String) -> Result(String, String)Keep generated paths beneath their owner, including on Windows.
server_options(doc: tome.Toml) -> Result(ServerOptions, String)
INFERRED
fn($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.
with_params(site: Config, params: json.Json) -> Config
INFERRED
fn(jinks/config.Config, $package/pooka_json/pooka/json.Json) -> jinks/config.Configbuild_options(doc: tome.Toml) -> Result(BuildOptions, String)
INFERRED
fn($package/tome/tome.Toml) -> Result(jinks/config.BuildOptions, String)boolean(doc: tome.Toml, key: String, fallback: Bool) -> Result(Bool, String)
INFERRED
fn($package/tome/tome.Toml, String, Bool) -> Result(Bool, String)markdown_options(doc: tome.Toml) -> Result(Bool, String)
INFERRED
fn($package/tome/tome.Toml) -> Result(Bool, String)