Hakyll.Web.Pandoc

Module exporting convenient pandoc bindings

The basic building blocks

readPandoc

Arguments

:: Item String

String to read

-> Compiler (Item Pandoc)

Resulting document

Read a string using pandoc, with the default options

readPandocWith

Arguments

:: ReaderOptions

Parser options

-> Item String

String to read

-> Compiler (Item Pandoc)

Resulting document

Read a string using pandoc, with the supplied options

writePandoc

Arguments

:: Item Pandoc

Document to write

-> Item String

Resulting HTML

Write a document (as HTML) using pandoc, with the default options

writePandocWith

Arguments

:: WriterOptions

Writer options for pandoc

-> Item Pandoc

Document to write

-> Item String

Resulting HTML

Write a document (as HTML) using pandoc, with the supplied options

renderPandoc :: Item String -> Compiler (Item String)

Render the resource using pandoc

renderPandocWith :: ReaderOptions -> WriterOptions -> Item String -> Compiler (Item String)

Render the resource using pandoc

renderPandocWithTransform :: ReaderOptions -> WriterOptions -> (Pandoc -> Pandoc) -> Item String -> Compiler (Item String)

An extension of renderPandocWith, which allows you to specify a custom Pandoc transformation on the input Item. Useful if you want to do your own transformations before running custom Pandoc transformations, e.g. using a funcField to transform raw content.

renderPandocWithTransformM :: ReaderOptions -> WriterOptions -> (Pandoc -> Compiler Pandoc) -> Item String -> Compiler (Item String)

Similar to renderPandocWithTransform, but the Pandoc transformation is monadic. This is useful when you want the pandoc transformation to use the Compiler information such as routes, metadata, etc. along with your own transformations beforehand.

Derived compilers

pandocCompiler :: Compiler (Item String)

Read a page render using pandoc

pandocCompilerWith :: ReaderOptions -> WriterOptions -> Compiler (Item String)

A version of pandocCompiler which allows you to specify your own pandoc options

pandocCompilerWithTransform :: ReaderOptions -> WriterOptions -> (Pandoc -> Pandoc) -> Compiler (Item String)

An extension of pandocCompilerWith which allows you to specify a custom pandoc transformation for the content

pandocCompilerWithTransformM :: ReaderOptions -> WriterOptions -> (Pandoc -> Compiler Pandoc) -> Compiler (Item String)

Similar to pandocCompilerWithTransform, but the transformation function is monadic. This is useful when you want the pandoc transformation to use the Compiler information such as routes, metadata, etc

Default options

defaultHakyllReaderOptions :: ReaderOptions

The default reader options for pandoc parsing in hakyll

defaultHakyllWriterOptions :: WriterOptions

The default writer options for pandoc rendering in hakyll