Module

jinks/publishing

src/jinks/publishing.pooka

Feeds and indexes come from the visible page catalog, never from a second filesystem walk. Drafts and future pages therefore obey the same choice as HTML. Names join publication's collision check before any output is written.

API reference

function

absolute

src/jinks/publishing.pooka:25
absolute(base: String, url: String) -> String
INFERREDfn(String, String) -> String

Append a generated site-relative URL beneath an optional deployment prefix.

Pooka
assert publishing.absolute("https://example.org/blog/", "/owl/") == "https://example.org/blog/owl/"
function

validate_base

src/jinks/publishing.pooka:29
validate_base(base: String) -> Result(Nil, String)
INFERREDfn(String) -> Result(Nil, String)
function

prepare

src/jinks/publishing.pooka:47
prepare(
  site: config.Config,
  pages: List(content.Page),
  outputs: List(String),
  clock: String,
  rendered: List(#(String, String))
) -> Result(List(#(String, String)), String)
INFERREDfn(jinks/config.Config, List(jinks/content.Page), List(String), String, List(#(String, String))) -> Result(List(#(String, String)), String)
function

plain

src/jinks/publishing.pooka:127
plain(source: String) -> String
INFERREDfn(String) -> String

Strip markup before exporting searchable text. Entity decoding is one pass; authored ampersands must not accidentally become a second round of markup.

function

atom

src/jinks/publishing.pooka:156
atom(site: config.Config, posts: List(content.Page), updated: String) -> String
INFERREDfn(jinks/config.Config, List(jinks/content.Page), String) -> String
function

entry_id

src/jinks/publishing.pooka:180
entry_id(site: config.Config, page: content.Page) -> String
function

feed_title

src/jinks/publishing.pooka:187
feed_title(site: config.Config) -> String
INFERREDfn(jinks/config.Config) -> String
function

feed_description

src/jinks/publishing.pooka:194
feed_description(site: config.Config) -> String
INFERREDfn(jinks/config.Config) -> String
function

sitemap

src/jinks/publishing.pooka:204
sitemap(site: config.Config, outputs: List(String)) -> String
INFERREDfn(jinks/config.Config, List(String)) -> String
function

rss

src/jinks/publishing.pooka:216
rss(site: config.Config, posts: List(content.Page)) -> String
INFERREDfn(jinks/config.Config, List(jinks/content.Page)) -> String
function

names

src/jinks/publishing.pooka:243
names(site: config.Config) -> List(String)
INFERREDfn(jinks/config.Config) -> List(String)
function

xml

src/jinks/publishing.pooka:262
xml(source: String) -> String
INFERREDfn(String) -> String

XML 1.0 excludes a few otherwise valid Unicode scalars. Drop those before escaping so one pasted control character cannot break an entire feed.