Text.Markdown

Functions

markdown :: MarkdownSettings -> Text -> Html

Convert the given textual markdown content to HTML.

>>> :set -XOverloadedStrings
>>> import Text.Blaze.Html.Renderer.Text
>>> renderHtml $ markdown def "# Hello World!"
"<h1>Hello World!</h1>"

>>> renderHtml $ markdown def { msXssProtect = False } "<script>alert('evil')</script>"
"<script>alert('evil')</script>"

Settings

data MarkdownSettings

A settings type providing various configuration options.

See http://www.yesodweb.com/book/settings-types for more information on settings types. In general, you can use def.

Instances

Default MarkdownSettings

msXssProtect :: MarkdownSettings -> Bool

Whether to automatically apply XSS protection to embedded HTML. Default: True.

Newtype

newtype Markdown

A newtype wrapper providing a ToHtml instance.

Constructors

Markdown Text

Instances

IsString Markdown

Monoid Markdown

ToMarkup Markdown

Convenience re-exports

def :: Default a => a

The default value for this type.