hakyll-2.4.1: A simple static site generator library.

Text.Hakyll.HakyllAction

Description

This is the module which exports HakyllAction.

Synopsis

Documentation

data HakyllAction a b Source

Type used for rendering computations that carry along dependencies.

Constructors

HakyllAction 

Fields

actionDependencies :: [FilePath]

Dependencies of the HakyllAction.

actionUrl :: Either (Hakyll FilePath) (Hakyll FilePath -> Hakyll FilePath)

URL pointing to the result of this HakyllAction.

actionFunction :: a -> Hakyll b

The actual render function.

createHakyllActionSource

Arguments

:: (a -> Hakyll b)

Function to execute.

-> HakyllAction a b 

Create a HakyllAction from a function.

createSimpleHakyllActionSource

Arguments

:: Hakyll b

Hakyll value to pass on.

-> HakyllAction () b 

Create a HakyllAction from a simple Hakyll value.

createFileHakyllActionSource

Arguments

:: FilePath

File to operate on.

-> Hakyll b

Value to pass on.

-> HakyllAction () b

The resulting action.

Create a HakyllAction that operates on one file.

chainSource

Arguments

:: [HakyllAction a a]

Actions to chain.

-> HakyllAction a a

Resulting action.

Chain a number of HakyllAction computations.

runHakyllActionSource

Arguments

:: HakyllAction () a

Render action to run.

-> Hakyll a

Result of the action.

Run a HakyllAction now.

runHakyllActionIfNeededSource

Arguments

:: HakyllAction () ()

Action to run.

-> Hakyll ()

Empty result.

Run a HakyllAction, but only when it is out-of-date. At this point, the actionUrl field must be set.