| Safe Haskell | Safe-Infered |
|---|
Hakyll.Web.Pandoc
Description
Module exporting pandoc bindings
- readPandoc :: FileType -> Maybe (Identifier a) -> String -> Pandoc
- readPandocWith :: ParserState -> FileType -> Maybe (Identifier a) -> String -> Pandoc
- writePandoc :: Pandoc -> String
- writePandocWith :: WriterOptions -> Pandoc -> String
- pageReadPandoc :: Compiler (Page String) (Page Pandoc)
- pageReadPandocWith :: ParserState -> Compiler (Page String) (Page Pandoc)
- pageReadPandocWithA :: Compiler (ParserState, Page String) (Page Pandoc)
- pageRenderPandoc :: Compiler (Page String) (Page String)
- pageRenderPandocWith :: ParserState -> WriterOptions -> Compiler (Page String) (Page String)
- defaultHakyllParserState :: ParserState
- defaultHakyllWriterOptions :: WriterOptions
The basic building blocks
Arguments
| :: FileType | Determines how parsing happens |
| -> Maybe (Identifier a) | Optional, for better error messages |
| -> String | String to read |
| -> Pandoc | Resulting document |
Read a string using pandoc, with the default options
Arguments
| :: ParserState | Parser options |
| -> FileType | Determines parsing method |
| -> Maybe (Identifier a) | Optional, for better error messages |
| -> String | String to read |
| -> 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 |
| -> Pandoc | Document to write |
| -> String | Resulting HTML |
Write a document (as HTML) using pandoc, with the supplied options
Functions working on pages/compilers
pageReadPandocWith :: ParserState -> Compiler (Page String) (Page Pandoc)Source
Read the resource using pandoc
pageReadPandocWithA :: Compiler (ParserState, Page String) (Page Pandoc)Source
Read the resource using pandoc. This is a (rarely needed) variant, which comes in very useful when the parser state is the result of some arrow.
pageRenderPandocWith :: ParserState -> WriterOptions -> Compiler (Page String) (Page String)Source
Render the resource using pandoc
Default options
defaultHakyllParserState :: ParserStateSource
The default reader options for pandoc parsing in hakyll
defaultHakyllWriterOptions :: WriterOptionsSource
The default writer options for pandoc rendering in hakyll