Serum.Page (serum v1.5.1) View Source

Defines a struct describing a normal page.

Fields

file: Source path
type: Type of source file
title: Page title
label: Page label
group: A group the page belongs to
order: Order of the page within its group
url: Absolute URL of the page within the website
output: Destination path
data: Source data

Link to this section Summary

Types

t()

Functions

compact(page)

new(path, arg, data, proj)

to_fragment(page)

Link to this section Types

t()

Specs

t() :: %Serum.Page{
  data: binary(),
  extras: map(),
  file: binary(),
  group: binary(),
  label: binary(),
  order: integer(),
  output: binary(),
  template: binary() | nil,
  title: binary(),
  type: binary(),
  url: binary()
}

Link to this section Functions

compact(page)

Specs

compact(t()) :: map()

new(path, arg, data, proj)

Specs

new(binary(), {map(), map()}, binary(), map()) :: t()

to_fragment(page)

Specs

to_fragment(t()) :: Serum.Result.t(Serum.Fragment.t())