Text.Hakyll.HakyllMonad

Module describing the Hakyll monad stack.

Documentation

data HakyllConfiguration

Hakyll global configuration type.

Constructors

HakyllConfiguration

Fields

absoluteUrl :: String

Absolute URL of the site.

additionalContext :: Context

An additional context to use when rendering. This additional context is used globally.

siteDirectory :: FilePath

Directory where the site is placed.

cacheDirectory :: FilePath

Directory for cache files.

enableIndexUrl :: Bool

Enable index links.

previewMode :: PreviewMode

The preview mode used

pandocParserState :: ParserState

Pandoc parsing options

pandocWriterOptions :: WriterOptions

Pandoc writer options

hamletSettings :: HamletSettings

Hamlet settings (if you use hamlet for templates)

data PreviewMode

Preview mode.

Constructors

BuildOnRequest

BuildOnInterval

Instances

Eq PreviewMode

Ord PreviewMode

Show PreviewMode

type Hakyll = ReaderT HakyllConfiguration IO

Our custom monad stack.

askHakyll :: (HakyllConfiguration -> a) -> Hakyll a

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 -> Context

Obtain the globally available, additional context.

logHakyll :: String -> Hakyll ()

Write some log information.

forkHakyllWait :: Hakyll () -> Hakyll (MVar ())

Perform a concurrent hakyll action. Returns an MVar you can wait on

concurrentHakyll :: [Hakyll ()] -> Hakyll ()

Perform a number of concurrent hakyll actions, and waits for them to finish