Safe Haskell	None
Language	Haskell98

Text.Sundown.Html

Contents

Generic ByteString conversion
Markdown extensions
Html render modes

Description

Module exposing a generic class to convert to/from UTF8 ByteStrings, and the corresponding generic markdown functions.

Synopsis

renderHtml :: (ToBS a, FromBS b) => Extensions -> HtmlRenderMode -> Bool -> Maybe Int -> a -> b
smartypants :: (ToBS a, FromBS b) => a -> b
class ToBS a where
- toBS :: a -> ByteString
class FromBS a where
- fromBS :: ByteString -> a
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 Source #

Arguments

:: (ToBS a, FromBS b)
=> 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.
-> a
-> b

Parses markdown, returns the Html.

smartypants :: (ToBS a, FromBS b) => a -> b Source #

Generic ByteString conversion

class ToBS a where Source #

Converts something to an UTF8 ByteString.

Methods

toBS :: a -> ByteString Source #

Instances

Instances details

ToBS ByteString Source #
Instance details Defined in Text.Sundown.Html Methods toBS :: ByteString -> ByteString Source #
ToBS Text Source #
Instance details Defined in Text.Sundown.Html Methods toBS :: Text -> ByteString Source #
ToBS [Char] Source #
Instance details Defined in Text.Sundown.Html Methods toBS :: [Char] -> ByteString Source #

class FromBS a where Source #

Converts an UTF8 ByteString to something.

Methods

fromBS :: ByteString -> a Source #

Instances

Instances details

FromBS ByteString Source #
Instance details Defined in Text.Sundown.Html Methods fromBS :: ByteString -> ByteString Source #
FromBS Text Source #
Instance details Defined in Text.Sundown.Html Methods fromBS :: ByteString -> Text Source #
FromBS [Char] Source #
Instance details Defined in Text.Sundown.Html Methods fromBS :: ByteString -> [Char] Source #

Markdown extensions

data Extensions Source #

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 Source #

All Extensions enabled

noExtensions :: Extensions Source #

All Extensions disabled

Html render modes

data HtmlRenderMode Source #

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 Source #

All the HtmlRenderMode disabled

allHtmlModes :: HtmlRenderMode Source #

All the HtmlRenderMode enabled