Yesod.Markdown

This module provides functions for using Markdown with Yesod. An example pipeline could be

 (writePandoc defaultWriterOptions <$>) . localLinks . parseMarkdown defaultParserState

Documentation

newtype Markdown

Constructors

Markdown String

Instances

Eq Markdown

Ord Markdown

Read Markdown

Show Markdown

IsString Markdown

Monoid Markdown

PersistField Markdown

ToFormField Markdown y

ToFormField (Maybe Markdown) y

parseMarkdown :: ParserState -> Markdown -> Pandoc

Read in Markdown to an intermediate Pandoc type.

localLinks :: Yesod master => Pandoc -> GHandler sub master Pandoc

Convert local (in-site) links. This function works on all link URLs that start with the two-character prefix ~:. It normalizes the links and replaces the ~: with the approot value for the site.

writePandoc :: WriterOptions -> Pandoc -> Html

Write untrusted Pandoc to Html. Calls sanitizeBalance from xss-sanitize.

writePandocTrusted :: WriterOptions -> Pandoc -> Html

Write trusted Pandoc to Html. Does not sanitize or balance tags.

Option sets

yesodDefaultWriterOptions :: WriterOptions

A set of default Pandoc writer options good for Yesod websites. Enables Javascript-based email obfuscation, eliminates div tags around sections, and disables text wrapping.

yesodDefaultParserState :: ParserState

A set of default Pandoc reader options good for Yesod websites. Enables smart parsing.

yesodDefaultParserStateTrusted :: ParserState

A set of default Pandoc reader options good for Yesod websites where the data input is trusted. Enables raw HTML.