OGMate.Theme (OGMate v0.1.0)

Copy Markdown View Source

Theme for OG image rendering.

Options

Summary

Functions

Schema for theme keys. Exposed for embedding in other NimbleOptions schemas.

Validate a theme keyword list, return a %OGMate.Theme{} struct.

Types

t()

@type t() :: %OGMate.Theme{
  background: String.t(),
  font: String.t(),
  foreground: String.t(),
  logo: String.t() | nil,
  secondary: String.t(),
  site_name: String.t() | nil
}

Functions

schema()

Schema for theme keys. Exposed for embedding in other NimbleOptions schemas.

validate!(theme)

@spec validate!(keyword()) :: t()

Validate a theme keyword list, return a %OGMate.Theme{} struct.