-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Bindings to the sundown markdown library
--   
--   Bindings to the github fork of sundown, a nice C markdown library:
--   <a>https://github.com/tanoku/sundown</a>
@package sundown
@version 0.4

module Text.Sundown.Renderers.Html

-- | Parses a <a>ByteString</a> containing the markdown, returns the Html
--   code.
renderHtml :: ByteString -> Extensions -> HtmlRenderMode -> Maybe Int -> ByteString

-- | All the <a>HtmlRenderMode</a> disabled
noHtmlModes :: HtmlRenderMode

-- | All the <a>HtmlRenderMode</a> enabled
allHtmlModes :: HtmlRenderMode

-- | Converts punctuation in Html entities,
--   <a>http://daringfireball.net/projects/smartypants/</a>
smartypants :: ByteString -> ByteString
data HtmlRenderMode
HtmlRenderMode :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> HtmlRenderMode

-- | Drop in-line HTML tags from the output
htmlSkipHtml :: HtmlRenderMode -> Bool

-- | Don't add any style tags to the output
htmlSkipStyle :: HtmlRenderMode -> Bool

-- | Don't include images in the output
htmlSkipImages :: HtmlRenderMode -> Bool

-- | Don't include links in the output
htmlSkipLinks :: HtmlRenderMode -> Bool
htmlExpandTabs :: HtmlRenderMode -> Bool

-- | Sanity check links for known URL schemes
htmlSafelink :: HtmlRenderMode -> Bool

-- | Include a table of contents in the output
htmlToc :: HtmlRenderMode -> Bool
htmlHardWrap :: HtmlRenderMode -> Bool

-- | Produce XHTML output instead of HTML
htmlUseXhtml :: HtmlRenderMode -> Bool

module Text.Sundown.Markdown

-- | A set of switches to enable or disable markdown features.
data Extensions
Extensions :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Extensions

-- | Turn off underscores insode a word does designating emphasis.
extNoIntraEmphasis :: Extensions -> Bool
extTables :: Extensions -> Bool

-- | Turns on a non-indentation form of code-blocks, by blocking off a
--   regionwith ~ or `.
extFencedCode :: Extensions -> Bool

-- | Turn things that look like URLs and email addresses into links
extAutolink :: Extensions -> Bool

-- | Surround text with `~` to designate it as struck through
extStrikethrough :: Extensions -> Bool

-- | Allow HTML markup inside of paragraphs, instead requireing tags to be
--   on separate lines
extLaxHtmlBlocks :: Extensions -> Bool
extSpaceHeaders :: Extensions -> Bool
extSuperscript :: Extensions -> Bool

-- | All <a>Extensions</a> enabled
allExtensions :: Extensions

-- | All <a>Extensions</a> disabled
noExtensions :: Extensions


-- | Bindings to the github fork of the sundown library - previously known
--   as upskirt: <a>https://github.com/tanoku/sundown</a>
--   
--   Example usage:
--   
--   <pre>
--   import Text.Sundown
--   import Text.Sundown.Renderers.Html
--   import qualified Data.ByteString as BS
--   import qualified Data.ByteString.UTF8 as UTF8
--   import System (getArgs)
--   import Control.Monad (liftM)
--   
--   main :: IO ()
--   main = do
--     input &lt;- liftM (!! 0) getArgs &gt;&gt;= BS.readFile
--     putStrLn $ UTF8.toString $ renderHtml input allExtensions noHtmlModes Nothing
--   </pre>
module Text.Sundown