Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Modulesundown-0.6Haskell98

Text.Sundown.Html.ByteString

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.

Contents

Markdown extensions
Html render modes

Synopsis

value renderHtml
value smartypants
data Extensions
value allExtensions
value noExtensions
data HtmlRenderMode
value noHtmlModes
value allHtmlModes

Packagesundown-0.6
Exports8
LanguageHaskell98
LicenceLicenseRef-PublicDomain
SourceByteString.hs

valuerenderHtml

:: 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.

valuesmartypants :: ByteString -> ByteString

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

Markdown extensions

datadata Extensions

A set of switches to enable or disable markdown features.

Constructors

Extensions
- 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

Instances1Flag

Flag ExtensionsDefined in sundown-0.6 · Text.Sundown.Foreign

valueallExtensions :: Extensions

All Extensions enabled

valuenoExtensions :: Extensions

All Extensions disabled

Html render modes

datadata HtmlRenderMode

Constructors

HtmlRenderMode
- 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

Instances1Flag

Flag HtmlRenderModeDefined in sundown-0.6 · Text.Sundown.Html.Foreign

valuenoHtmlModes :: HtmlRenderMode

All the HtmlRenderMode disabled

valueallHtmlModes :: HtmlRenderMode

All the HtmlRenderMode enabled