Serum.Page (serum_md v1.7.0)

Copy Markdown 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

Summary

Types

t()

Functions

compact(page)
new(path, arg, data, proj)
to_fragment(page)

Types

t()

@type 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()
}

Functions

compact(page)

@spec compact(t()) :: map()

new(path, arg, data, proj)

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

to_fragment(page)

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