Cherry.Build (cherry v0.1.0-rc.3)

Copy Markdown View Source

The build token: the single value every pipeline stage takes and returns (Tableau's proven shape). Stages are pure token -> token transformations; only load and emit touch the filesystem.

documents are parsed content on their way to becoming pages (the layout stage performs that conversion); assets copy through untouched.

Summary

Types

t()

Functions

new(site, options)

Starts a build token from a loaded site and build options.

Types

t()

@type t() :: %Cherry.Build{
  assets: [Cherry.Content.Asset.t()],
  documents: [Cherry.Content.Document.t()],
  options: Cherry.Build.Options.t(),
  pages: [Cherry.Content.Page.t()],
  profile: Cherry.Portfolio.Profile.t() | nil,
  site: Cherry.Site.t()
}

Functions

new(site, options)

@spec new(Cherry.Site.t(), Cherry.Build.Options.t()) :: t()

Starts a build token from a loaded site and build options.