hakyll-0.4.1: A simple static site generator library.Source codeContentsIndex
Text.Hakyll.Render
Synopsis
depends :: FilePath -> [FilePath] -> IO () -> IO ()
render :: Renderable a => FilePath -> a -> IO Page
renderWith :: Renderable a => ContextManipulation -> FilePath -> a -> IO Page
renderAndConcat :: Renderable a => FilePath -> [a] -> IO ByteString
renderAndConcatWith :: Renderable a => ContextManipulation -> FilePath -> [a] -> IO ByteString
renderChain :: Renderable a => [FilePath] -> a -> IO ()
renderChainWith :: Renderable a => ContextManipulation -> [FilePath] -> a -> IO ()
static :: FilePath -> IO ()
css :: FilePath -> IO ()
Documentation
dependsSource
:: FilePathFile to be rendered or created.
-> [FilePath]Files the render depends on.
-> IO ()IO action to execute when the file is out of date.
-> IO ()
Execute an IO action only when the cache is invalid.
renderSource
:: Renderable a
=> FilePathRenderable object to render with given template.
-> aThe body of the result will contain the render.
-> IO Page
Render to a Page.
renderWithSource
:: Renderable a
=> ContextManipulationTemplate to use for rendering.
-> FilePathRenderable object to render with given template.
-> aThe body of the result will contain the render.
-> IO Page
Render to a Page. This function allows you to manipulate the context first.
renderAndConcat :: Renderable a => FilePath -> [a] -> IO ByteStringSource
Render each renderable with the given template, then concatenate the result.
renderAndConcatWith :: Renderable a => ContextManipulation -> FilePath -> [a] -> IO ByteStringSource
Render each renderable with the given template, then concatenate the result. This function allows you to specify a ContextManipulation to apply on every Renderable.
renderChain :: Renderable a => [FilePath] -> a -> IO ()Source
Chain a render action for a page with a number of templates. This will also write the result to the site destination. This is the preferred way to do general rendering.
renderChainWith :: Renderable a => ContextManipulation -> [FilePath] -> a -> IO ()Source
A more custom render chain that allows you to specify a ContextManipulation which to apply on the context when it is read first.
static :: FilePath -> IO ()Source
Mark a certain file as static, so it will just be copied when the site is generated.
css :: FilePath -> IO ()Source
Render a css file, compressing it.
Produced by Haddock version 2.6.0