Hakyll.Core.Routes

Once a target is compiled, the user usually wants to save it to the disk. This is where the Routes type comes in; it determines where a certain target should be written.

Suppose we have an item foo/bar.markdown. We can render this to foo/bar.html using:

route "foo/bar.markdown" (setExtension ".html")

If we do not want to change the extension, we can use idRoute, the simplest route available:

route "foo/bar.markdown" idRoute

That will route foo/bar.markdown to foo/bar.markdown.

Note that the extension says nothing about the content! If you set the extension to .html, it is your own responsibility to ensure that the content is indeed HTML.

Finally, some special cases:

• If there is no route for an item, this item will not be routed, so it will not appear in your site directory.
• If an item matches multiple routes, the first rule will be chosen.

Documentation

type UsedMetadata = Bool

When you ran a route, it's useful to know whether or not this used metadata. This allows us to do more granular dependency analysis.

data Routes

Type used for a route

Instances

Monoid Routes

Methods

mempty :: Routes

mappend :: Routes -> Routes -> Routes

mconcat :: [Routes] -> Routes

runRoutes :: Routes -> Provider -> Identifier -> IO (Maybe FilePath, UsedMetadata)

Apply a route to an identifier

idRoute :: Routes

A route that uses the identifier as filepath. For example, the target with ID foo/bar will be written to the file foo/bar.

setExtension :: String -> Routes

Set (or replace) the extension of a route.

Example:

runRoutes (setExtension "html") "foo/bar"

Result:

Just "foo/bar.html"

Example:

runRoutes (setExtension "html") "posts/the-art-of-trolling.markdown"

Result:

Just "posts/the-art-of-trolling.html"

matchRoute :: Pattern -> Routes -> Routes

Apply the route if the identifier matches the given pattern, fail otherwise

customRoute :: (Identifier -> FilePath) -> Routes

Create a custom route. This should almost always be used with matchRoute

constRoute :: FilePath -> Routes

A route that always gives the same result. Obviously, you should only use this for a single compilation rule.

gsubRoute

Arguments

:: String

Pattern

-> (String -> String)

Replacement

-> Routes

Resulting route

Create a gsub route

Example:

runRoutes (gsubRoute "rss/" (const "")) "tags/rss/bar.xml"

Result:

Just "tags/bar.xml"

metadataRoute :: (Metadata -> Routes) -> Routes

Get access to the metadata in order to determine the route

composeRoutes

Arguments

:: Routes

First route to apply

-> Routes

Second route to apply

-> Routes

Resulting route

Compose routes so that f `composeRoutes` g is more or less equivalent with g . f.

Example:

let routes = gsubRoute "rss/" (const "") `composeRoutes` setExtension "xml"
in runRoutes routes "tags/rss/bar"

Result:

Just "tags/bar.xml"

If the first route given fails, Hakyll will not apply the second route.