Safe Haskell | None |
---|---|
Language | Haskell98 |
Hakyll.Web.Pandoc
Description
Module exporting convenient pandoc bindings
- readPandoc :: Item String -> Item Pandoc
- readPandocWith :: ReaderOptions -> Item String -> Item Pandoc
- writePandoc :: Item Pandoc -> Item String
- writePandocWith :: WriterOptions -> Item Pandoc -> Item String
- renderPandoc :: Item String -> Item String
- renderPandocWith :: ReaderOptions -> WriterOptions -> Item String -> Item String
- pandocCompiler :: Compiler (Item String)
- pandocCompilerWith :: ReaderOptions -> WriterOptions -> Compiler (Item String)
- pandocCompilerWithTransform :: ReaderOptions -> WriterOptions -> (Pandoc -> Pandoc) -> Compiler (Item String)
- pandocCompilerWithTransformM :: ReaderOptions -> WriterOptions -> (Pandoc -> Compiler Pandoc) -> Compiler (Item String)
- defaultHakyllReaderOptions :: ReaderOptions
- defaultHakyllWriterOptions :: WriterOptions
The basic building blocks
Read a string using pandoc, with the default options
Arguments
:: ReaderOptions | Parser options |
-> Item String | String to read |
-> Item Pandoc | Resulting document |
Read a string using pandoc, with the supplied options
Write a document (as HTML) using pandoc, with the default options
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
renderPandocWith :: ReaderOptions -> WriterOptions -> Item String -> Item String Source
Render the resource using pandoc
Derived compilers
pandocCompiler :: Compiler (Item String) Source
Read a page render using pandoc
pandocCompilerWith :: ReaderOptions -> WriterOptions -> Compiler (Item String) Source
A version of pandocCompiler
which allows you to specify your own pandoc
options
pandocCompilerWithTransform :: ReaderOptions -> WriterOptions -> (Pandoc -> Pandoc) -> Compiler (Item String) Source
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) Source
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 Source
The default reader options for pandoc parsing in hakyll
defaultHakyllWriterOptions :: WriterOptions Source
The default writer options for pandoc rendering in hakyll