hakyll-2.0: A simple static site generator library.Source codeContentsIndex
Text.Hakyll.HakyllMonad
Description
Module describing the Hakyll monad stack.
Synopsis
data HakyllConfiguration = HakyllConfiguration {
absoluteUrl :: String
additionalContext :: Context
siteDirectory :: FilePath
cacheDirectory :: FilePath
enableIndexUrl :: Bool
previewPollDelay :: Int
}
type Hakyll = ReaderT HakyllConfiguration IO
askHakyll :: (HakyllConfiguration -> a) -> Hakyll a
getAdditionalContext :: HakyllConfiguration -> Context
Documentation
data HakyllConfiguration Source
Hakyll global configuration type.
Constructors
HakyllConfiguration
absoluteUrl :: StringAbsolute URL of the site.
additionalContext :: ContextAn additional context to use when rendering. This additional context is used globally.
siteDirectory :: FilePathDirectory where the site is placed.
cacheDirectory :: FilePathDirectory for cache files.
enableIndexUrl :: BoolEnable index links.
previewPollDelay :: IntDelay between polls in preview mode.
type Hakyll = ReaderT HakyllConfiguration IOSource
Our custom monad stack.
askHakyll :: (HakyllConfiguration -> a) -> Hakyll aSource

Simplified ask function for the Hakyll monad stack.

Usage would typically be something like: 

 doSomething :: a -> b -> Hakyll c
 doSomething arg1 arg2 = do
     siteDirectory' <- askHakyll siteDirectory
     ...
getAdditionalContext :: HakyllConfiguration -> ContextSource
Produced by Haddock version 2.7.2