Module

jinks/publishing_options

src/jinks/publishing_options.pooka

Machine-readable neighbours belong to the same publication as the pages. They are opt-in, so an existing authored feed never gets overwritten by a newly invented default. Unknown settings are errors, not silent typos.

API reference

class

Options

src/jinks/publishing_options.pooka:11
class Options(
  feed: Bool,
  sitemap: Bool,
  search: Bool,
  robots: Bool,
  collection: String,
  format: String,
  limit: Int,
  title: Option(String),
  description: Option(String)
)
field

feed

src/jinks/publishing_options.pooka:12
feed: Bool
INFERREDBool
field

sitemap

src/jinks/publishing_options.pooka:13
sitemap: Bool
INFERREDBool
field

search

src/jinks/publishing_options.pooka:14
search: Bool
INFERREDBool
field

robots

src/jinks/publishing_options.pooka:15
robots: Bool
INFERREDBool
field

collection

src/jinks/publishing_options.pooka:16
collection: String
INFERREDString
field

format

src/jinks/publishing_options.pooka:17
format: String
INFERREDString
field

limit

src/jinks/publishing_options.pooka:18
limit: Int
INFERREDInt
field

title

src/jinks/publishing_options.pooka:19
title: Option(String)
INFERREDOption(String)
field

description

src/jinks/publishing_options.pooka:20
description: Option(String)
INFERREDOption(String)
constructor

new

src/jinks/publishing_options.pooka:12
INFERREDfn(Bool, Bool, Bool, Bool, String, String, Int, Option(String), Option(String)) -> jinks/publishing_options.Options
function

parse

src/jinks/publishing_options.pooka:23
parse(doc: tome.Toml) -> Result(Options, String)
INFERREDfn($package/tome/tome.Toml) -> Result(jinks/publishing_options.Options, String)
function

flag

src/jinks/publishing_options.pooka:80
flag(table: tome.Toml, name: String) -> Result(Bool, String)
INFERREDfn($package/tome/tome.Toml, String) -> Result(Bool, String)
function

optional_text

src/jinks/publishing_options.pooka:88
optional_text(table: tome.Toml, name: String) -> Result(Option(String), String)
INFERREDfn($package/tome/tome.Toml, String) -> Result(Option(String), String)