Text.Hakyll.Renderables

Documentation

data CustomPage

A custom page.

Instances

Renderable CustomPage

createCustomPage

Arguments

:: String

Destination of the page, relative to _site.

-> [FilePath]

Dependencies of the page.

-> [(String, Either String (Hakyll String))]

Mapping.

-> CustomPage

Create a custom page.

The association list given maps keys to values for substitution. Note that as value, you can either give a String or a Hakyll String. A Hakyll String is preferred for more complex data, since it allows dependency checking. A String is obviously more simple to use in some cases.

data PagePath

PagePath is a class that wraps a FilePath. This is used to render Pages without reading them first through use of caching.

Instances

Renderable PagePath

createPagePath :: FilePath -> PagePath

Create a PagePath from a FilePath.

data CombinedRenderable a b

A combination of two other renderables.

Instances

(Renderable a, Renderable b) => Renderable (CombinedRenderable a b)

Render combinations.

combine :: (Renderable a, Renderable b) => a -> b -> CombinedRenderable a b

Combine two renderables. The url will always be taken from the first Renderable. Also, if a `$key` is present in both renderables, the value from the first Renderable will be taken as well.

combineWithURL :: (Renderable a, Renderable b) => FilePath -> a -> b -> CombinedRenderable a b

Combine two renderables and set a custom URL.