sundown-0.6: Bindings to the sundown markdown library

Safe HaskellNone
LanguageHaskell98

Text.Sundown.Html.ByteString

Contents

Description

Warning: you should not need to use this module, if you're storing your text sanely. Use Text.Sundown.Html.String or Text.Sundown.Html.Text so that you won't have to worry about text encoding.

If you really want to use ByteStrings directly, make sure that they are UTF-8.

Synopsis

Documentation

renderHtml #

Arguments

:: Extensions 
-> HtmlRenderMode 
-> Bool

If true, smartypant the output

-> Maybe Int

The maximum nesting of the HTML. If Nothing, a default value (16) will be used.

-> ByteString 
-> ByteString 

Parses a ByteString containing the markdown, returns the Html code.

Markdown extensions

data Extensions #

A set of switches to enable or disable markdown features.

Constructors

Extensions 

Fields

Html render modes

data HtmlRenderMode #

Constructors

HtmlRenderMode 

Fields