pub type Author {
  Author(
    name: String,
    email: option.Option(String),
    url: option.Option(String),
  )
}

Constructors

• Author(
    name: String,
    email: option.Option(String),
    url: option.Option(String),
  )

  Arguments

  • name

    Name of the author.

  • email

    Email address of the author, used in the feed’s author information.

  • url

    Website URL of the author, used in the feed’s author information and added as a rel="me" link in the base layout.

pub type Compiling {
  Compiling(
    database_compiler: fn(Database, Compiler) -> CompileDatabase,
    item_compiler: Compiler,
  )
}

Constructors

• Compiling(
    database_compiler: fn(Database, Compiler) -> CompileDatabase,
    item_compiler: Compiler,
  )

  Arguments

  • database_compiler

    The compiler to use for compiling the database.

  • item_compiler

    The compiler to use for compiling individual items.

pub type Configuration {
  Configuration(
    blog_name: String,
    blog_url: String,
    author: Author,
    l10n: Localization,
    compiling: Compiling,
    rendering: Rendering,
    paths: PathConfiguration,
    parser: Parser,
    writer: Writer,
    output_path: String,
  )
}

Constructors

• Configuration(
    blog_name: String,
    blog_url: String,
    author: Author,
    l10n: Localization,
    compiling: Compiling,
    rendering: Rendering,
    paths: PathConfiguration,
    parser: Parser,
    writer: Writer,
    output_path: String,
  )

  Arguments

  • blog_name

    Name of the blog.

  • blog_url

    Absolute URL of the blog, this is where you are deploying it.

  • output_path

    The folder to write the output into.

pub type Localization {
  Localization(language: String, context: Context)
}

Constructors

• Localization(language: String, context: Context)

  Arguments

  • language

    Language code of the blog, meaning the language of the content you are writing. The language code must be according to https://datatracker.ietf.org/doc/html/rfc5646.

  • context

    Context to use for gettext operations for translating built-in strings.

pub type ParseError {
  ParseError(err: String)
}

Constructors

• ParseError(err: String)

pub type Parser =
  fn(Configuration) -> Result(Database, ParseError)

pub type Renderer =
  fn(Database, CompileDatabase, Configuration) -> RenderDatabase

pub type Rendering {
  Rendering(
    renderer: Renderer,
    views: Views,
    copyright: String,
    posts_per_page: Int,
    posts_in_feed: Int,
  )
}

Constructors

• Rendering(
    renderer: Renderer,
    views: Views,
    copyright: String,
    posts_per_page: Int,
    posts_in_feed: Int,
  )

  Arguments

  • renderer

    The renderer to use.

  • views

    The view generators to use.

  • copyright

    The copyright statement of the blog, used in the footer and the feed.

  • posts_per_page

    How many posts to show per page.

  • posts_in_feed

    How many posts to render in the feed.

pub type Views {
  Views(
    base: fn(Database, Configuration) -> BaseView,
    meta: fn(Database, Configuration) -> MetaView,
    single_post_full: fn(Database, Configuration) ->
      SinglePostView,
    single_post_list: fn(Database, Configuration) ->
      SinglePostView,
    page: fn(Database, Configuration) -> PageView,
    list_page: fn(Database, Configuration) -> ListPageView,
    feed: fn(Database, Configuration) -> FeedView,
  )
}

Constructors

• Views(
    base: fn(Database, Configuration) -> BaseView,
    meta: fn(Database, Configuration) -> MetaView,
    single_post_full: fn(Database, Configuration) -> SinglePostView,
    single_post_list: fn(Database, Configuration) -> SinglePostView,
    page: fn(Database, Configuration) -> PageView,
    list_page: fn(Database, Configuration) -> ListPageView,
    feed: fn(Database, Configuration) -> FeedView,
  )

  Arguments

  • single_post_full

    View for a single post that is rendered on its own.

  • single_post_list

    View for a single post rendered as part of a list.

pub type WriteError {
  WriteError(err: String)
}

Constructors

• WriteError(err: String)

pub type Writer =
  fn(RenderDatabase, Configuration) -> Result(Nil, WriteError)