Safe Haskell	None
Language	Haskell98

Text.Sundown.Html.ByteString

Contents

Markdown extensions
Html render modes

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

renderHtml :: Extensions -> HtmlRenderMode -> Bool -> Maybe Int -> ByteString -> ByteString
smartypants :: ByteString -> ByteString
data Extensions = Extensions {
- extNoIntraEmphasis :: Bool
- extTables :: Bool
- extFencedCode :: Bool
- extAutolink :: Bool
- extStrikethrough :: Bool
- extSpaceHeaders :: Bool
- extSuperscript :: Bool
- extLaxSpacing :: Bool
}
allExtensions :: Extensions
noExtensions :: Extensions
data HtmlRenderMode = HtmlRenderMode {
- htmlSkipHtml :: Bool
- htmlSkipStyle :: Bool
- htmlSkipImages :: Bool
- htmlSkipLinks :: Bool
- htmlExpandTabs :: Bool
- htmlSafelink :: Bool
- htmlToc :: Bool
- htmlHardWrap :: Bool
- htmlUseXhtml :: Bool
- htmlEscape :: Bool
}
noHtmlModes :: HtmlRenderMode
allHtmlModes :: HtmlRenderMode

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.

smartypants :: ByteString -> ByteString #

Converts punctuation in Html entities, http://daringfireball.net/projects/smartypants/

Markdown extensions

data Extensions #

A set of switches to enable or disable markdown features.

Constructors

Extensions

Fields

extNoIntraEmphasis :: Bool
Turn off underscores insode a word does designating emphasis.
extTables :: Bool
extFencedCode :: Bool
Turns on a non-indentation form of code-blocks, by blocking off a regionwith ~ or `.
extAutolink :: Bool
Turn things that look like URLs and email addresses into links
extStrikethrough :: Bool
Surround text with `~` to designate it as struck through
extSpaceHeaders :: Bool
extSuperscript :: Bool
extLaxSpacing :: Bool
Allow blocks inside of paragraphs, instead requireing tags to be on separate lines

allExtensions :: Extensions #

All Extensions enabled

noExtensions :: Extensions #

All Extensions disabled

Html render modes

data HtmlRenderMode #

Constructors

HtmlRenderMode

Fields

htmlSkipHtml :: Bool
Drop in-line HTML tags from the output
htmlSkipStyle :: Bool
Don't add any style tags to the output
htmlSkipImages :: Bool
Don't include images in the output
htmlSkipLinks :: Bool
Don't include links in the output
htmlExpandTabs :: Bool
htmlSafelink :: Bool
Sanity check links for known URL schemes
htmlToc :: Bool
Include a table of contents in the output
htmlHardWrap :: Bool
htmlUseXhtml :: Bool
Produce XHTML output instead of HTML
htmlEscape :: Bool

noHtmlModes :: HtmlRenderMode #

All the HtmlRenderMode disabled

allHtmlModes :: HtmlRenderMode #

All the HtmlRenderMode enabled