arctic - v9.0.3

arctic/config

Functions

add_collection

</> 
pub fn add_collection(
  config: Config,
  collection: Collection,
) -> Config

Add a “collection” to an Arctic configuration. A collection holds a bunch of pages and their processing rules, like a set of products, blog posts, wiki entries, etc. See arctic/collection for more.

add_main_page

</> 
pub fn add_main_page(
  config: Config,
  id: String,
  body: Element(Nil),
) -> Config

Add a “main page” to an Arctic configuration. Main pages are pages that aren’t a part of any collection, like “Contact” or “About.” Note that the home page (/index.html) is handled via home_renderer instead.

home_renderer

</> 
pub fn home_renderer(
  config: Config,
  renderer: fn(List(ProcessedCollection)) -> Element(Nil),
) -> Config

Set the renderer for the home page of a site (/index.html). Note that a list of all collections, with all of their pages, is provided if you’d like to use it.

new

</> 
pub fn new() -> Config

Produce a new Arctic configuration, with default settings. An Arctic configuration holds all the collections, pages, parsing rules, etc.

✨ Search Document