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


-- | Convert Markdown to HTML, with XSS protection
--   
--   This library leverages existing high-performance libraries
--   (attoparsec, blaze-html, text, and conduit), and should integrate well
--   with existing codebases.
@package markdown
@version 0.1.0

module Text.Markdown

-- | Convert the given textual markdown content to HTML.
--   
--   <pre>
--   &gt;&gt;&gt; :set -XOverloadedStrings
--   
--   &gt;&gt;&gt; import Text.Blaze.Html.Renderer.Text
--   
--   &gt;&gt;&gt; renderHtml $ markdown def "# Hello World!"
--   "&lt;h1&gt;Hello World!&lt;/h1&gt;"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; renderHtml $ markdown def { msXssProtect = False } "&lt;script&gt;alert('evil')&lt;/script&gt;"
--   "&lt;script&gt;alert('evil')&lt;/script&gt;"
--   </pre>
markdown :: MarkdownSettings -> Text -> Html

-- | A settings type providing various configuration options.
--   
--   See <a>http://www.yesodweb.com/book/settings-types</a> for more
--   information on settings types. In general, you can use <tt>def</tt>.
data MarkdownSettings

-- | Whether to automatically apply XSS protection to embedded HTML.
--   Default: <tt>True</tt>.
msXssProtect :: MarkdownSettings -> Bool

-- | A newtype wrapper providing a <tt>ToHtml</tt> instance.
newtype Markdown
Markdown :: Text -> Markdown

-- | The default value for this type.
def :: Default a => a
instance ToMarkup Markdown
instance Default MarkdownSettings