Yesod.Markdown

Rewrite/simplification of yesod-markdown written by ajdunlap.

Forked from https://github.com/ajdunlap/yesod-markdown.

Documentation

newtype Markdown

Constructors

Markdown String

Instances

Eq Markdown

Ord Markdown

Read Markdown

Show Markdown

IsString Markdown

Monoid Markdown

PersistField Markdown

ToField Markdown master

ToField (Maybe Markdown) master

Wrappers

markdownToHtml :: Markdown -> Html

Converts markdown directly to html using the yesod default option sets and sanitization.

markdownToHtmlTrusted :: Markdown -> Html

Same but with no sanitization run

markdownFromFile :: FilePath -> IO Markdown

Reads markdown in from the specified file; returns the empty string if the file does not exist

Conversions

parseMarkdown :: ParserState -> Markdown -> Pandoc

Parses Markdown into the intermediate Pandoc type

writePandoc :: WriterOptions -> Pandoc -> Html

Converts the intermediate Pandoc type to Html. Sanitizes HTML.

writePandocTrusted :: WriterOptions -> Pandoc -> Html

Skips the sanitization and its required conversion to Text

Option sets

yesodDefaultWriterOptions :: WriterOptions

Pandoc defaults, plus Html5, minus WrapText

yesodDefaultParserState :: ParserState

Pandoc defaults, plus Smart, plus ParseRaw

Form helper

markdownField :: RenderMessage master FormMessage => Field sub master Markdown