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.

msStandaloneHtml :: MarkdownSettings -> Set Text

HTML snippets which stand on their own. We do not require a blank line following these pieces of HTML.

Default: empty set.

Since: 0.1.2

msFencedHandlers :: MarkdownSettings -> Map Text (Text -> FencedHandler)

Handlers for the special "fenced" format. This is most commonly used for fenced code, e.g.:

 ```haskell
 main = putStrLn "Hello"
 ```

This is an extension of Markdown, but a fairly commonly used one.

This setting allows you to create new kinds of fencing. Fencing goes into two categories: parsed and raw. Code fencing would be in the raw category, where the contents are not treated as Markdown. Parsed will treat the contents as Markdown and allow you to perform some kind of modifcation to it.

For example, to create a new @@@ fencing which wraps up the contents in an article tag, you could use:

 def { msFencedHandlers = htmlFencedHandler "@@@" (const "<article>") (const "</article")
              `Map.union` msFencedHandlers def
     }

Default: code fencing for ``` and ~~~.

Since: 0.1.2

Newtype

newtype Markdown

A newtype wrapper providing a ToHtml instance.

Constructors

Markdown Text

Instances

IsString Markdown

Monoid Markdown

ToMarkup Markdown

Fenced handlers

data FencedHandler

See 'msFencedHandlers.

Since 0.1.2

Constructors

FHRaw (Text -> [Block Text])

Wrap up the given raw content.

FHParsed ([Block Text] -> [Block Text])

Wrap up the given parsed content.

codeFencedHandler

Arguments

:: Text

Delimiter

-> Map Text (Text -> FencedHandler)

Helper for creating a FHRaw.

Since 0.1.2

htmlFencedHandler

Arguments

:: Text

Delimiter

-> (Text -> Text)

start HTML

-> (Text -> Text)

end HTML

-> Map Text (Text -> FencedHandler)

Helper for creating a FHParsed.

Note that the start and end parameters take a Text parameter; this is the text following the delimiter. For example, with the markdown:

 @@@ foo

foo would be passed to start and end.

Since 0.1.2

Convenience re-exports

def :: Default a => a

The default value for this type.