hakyll-2.0: A simple static site generator library. Source code Contents Index

Text.Hakyll.HakyllAction

Description

This is the module which exports HakyllAction.

Synopsis

data HakyllAction a b = HakyllAction { actionDependencies :: [FilePath] actionUrl :: Maybe (Hakyll FilePath) actionFunction :: a -> Hakyll b } createHakyllAction :: (a -> Hakyll b) -> HakyllAction a b createSimpleHakyllAction :: Hakyll b -> HakyllAction () b createFileHakyllAction :: FilePath -> Hakyll b -> HakyllAction () b chain :: [HakyllAction a a] -> HakyllAction a a runHakyllAction :: HakyllAction () a -> Hakyll a runHakyllActionIfNeeded :: HakyllAction () () -> Hakyll ()

Documentation

data HakyllAction a b Source

Type used for rendering computations that carry along dependencies. Constructors HakyllAction actionDependencies :: [FilePath] Dependencies of the HakyllAction. actionUrl :: Maybe (Hakyll FilePath) URL pointing to the result of this HakyllAction. actionFunction :: a -> Hakyll b The actual render function. Instances Arrow HakyllAction Category HakyllAction

createHakyllAction Source

:: (a -> Hakyll b) Function to execute. -> HakyllAction a b Create a HakyllAction from a function.

createSimpleHakyllAction Source

:: Hakyll b Hakyll value to pass on. -> HakyllAction () b Create a HakyllAction from a simple Hakyll value.

createFileHakyllAction Source

:: FilePath File to operate on. -> Hakyll b Value to pass on. -> HakyllAction () b The resulting action. Create a HakyllAction that operates on one file.

chain Source

:: [HakyllAction a a] Actions to chain. -> HakyllAction a a Resulting action. Chain a number of HakyllAction computations.

runHakyllAction Source

:: HakyllAction () a Render action to run. -> Hakyll a Result of the action. Run a HakyllAction now.

runHakyllActionIfNeeded Source

:: 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.

Produced by Haddock version 2.7.2