/usr/share/doc/libghc-yesod-markdown-doc/html/Yesod-Markdown.html is in libghc-yesod-markdown-doc 0.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yesod.Markdown</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Yesod-Markdown.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Yesod-Markdown.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">yesod-markdown-0.4.0: Tools for using markdown in a yesod application</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Yesod.Markdown</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Wrappers
</a></li><li><a href="#g:2">Conversions
</a></li><li><a href="#g:3">Option sets
</a></li><li><a href="#g:4">Form helper
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Rewrite/simplification of yesod-markdown written by ajdunlap.
</p><p>Forked from <a href="https://github.com/ajdunlap/yesod-markdown">https://github.com/ajdunlap/yesod-markdown</a>.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">newtype</span> <a href="#t:Markdown">Markdown</a> = <a href="#v:Markdown">Markdown</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:markdownToHtml">markdownToHtml</a> :: <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a></li><li class="src short"><a href="#v:markdownToHtmlTrusted">markdownToHtmlTrusted</a> :: <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a></li><li class="src short"><a href="#v:markdownFromFile">markdownFromFile</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></li><li class="src short"><a href="#v:parseMarkdown">parseMarkdown</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Parsing.html#t:ParserState">ParserState</a> -> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> Pandoc</li><li class="src short"><a href="#v:writePandoc">writePandoc</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a> -> Pandoc -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a></li><li class="src short"><a href="#v:writePandocTrusted">writePandocTrusted</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a> -> Pandoc -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a></li><li class="src short"><a href="#v:yesodDefaultWriterOptions">yesodDefaultWriterOptions</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a></li><li class="src short"><a href="#v:yesodDefaultParserState">yesodDefaultParserState</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Parsing.html#t:ParserState">ParserState</a></li><li class="src short"><a href="#v:markdownField">markdownField</a> :: RenderMessage master <a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Types.html#t:FormMessage">FormMessage</a> => <a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Types.html#t:Field">Field</a> sub master <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Markdown" class="def">Markdown</a> <a href="src/Yesod-Markdown.html#Markdown" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Markdown" class="def">Markdown</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Markdown" class="caption collapser" onclick="toggleSection('i:Markdown')">Instances</p><div id="section.i:Markdown" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:IsString">IsString</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/libghc-persistent-doc/html/Database-Persist-Store.html#t:PersistField">PersistField</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Class.html#t:ToField">ToField</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> master</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Class.html#t:ToField">ToField</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a>) master</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:1">Wrappers
</h1><div class="top"><p class="src"><a name="v:markdownToHtml" class="def">markdownToHtml</a> :: <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a><a href="src/Yesod-Markdown.html#markdownToHtml" class="link">Source</a></p><div class="doc"><p>Converts markdown directly to html using the yesod default option
sets and sanitization.
</p></div></div><div class="top"><p class="src"><a name="v:markdownToHtmlTrusted" class="def">markdownToHtmlTrusted</a> :: <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a><a href="src/Yesod-Markdown.html#markdownToHtmlTrusted" class="link">Source</a></p><div class="doc"><p>Same but with no sanitization run
</p></div></div><div class="top"><p class="src"><a name="v:markdownFromFile" class="def">markdownFromFile</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a><a href="src/Yesod-Markdown.html#markdownFromFile" class="link">Source</a></p><div class="doc"><p>Reads markdown in from the specified file; returns the empty string
if the file does not exist
</p></div></div><h1 id="g:2">Conversions
</h1><div class="top"><p class="src"><a name="v:parseMarkdown" class="def">parseMarkdown</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Parsing.html#t:ParserState">ParserState</a> -> <a href="Yesod-Markdown.html#t:Markdown">Markdown</a> -> Pandoc<a href="src/Yesod-Markdown.html#parseMarkdown" class="link">Source</a></p><div class="doc"><p>Parses Markdown into the intermediate Pandoc type
</p></div></div><div class="top"><p class="src"><a name="v:writePandoc" class="def">writePandoc</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a> -> Pandoc -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a><a href="src/Yesod-Markdown.html#writePandoc" class="link">Source</a></p><div class="doc"><p>Converts the intermediate Pandoc type to Html. Sanitizes HTML.
</p></div></div><div class="top"><p class="src"><a name="v:writePandocTrusted" class="def">writePandocTrusted</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a> -> Pandoc -> <a href="/usr/share/doc/libghc-blaze-html-doc/html/Text-Blaze-Internal.html#t:Html">Html</a><a href="src/Yesod-Markdown.html#writePandocTrusted" class="link">Source</a></p><div class="doc"><p>Skips the sanitization and its required conversion to Text
</p></div></div><h1 id="g:3">Option sets
</h1><div class="top"><p class="src"><a name="v:yesodDefaultWriterOptions" class="def">yesodDefaultWriterOptions</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Shared.html#t:WriterOptions">WriterOptions</a><a href="src/Yesod-Markdown.html#yesodDefaultWriterOptions" class="link">Source</a></p><div class="doc"><p>Pandoc defaults, plus Html5, minus WrapText
</p></div></div><div class="top"><p class="src"><a name="v:yesodDefaultParserState" class="def">yesodDefaultParserState</a> :: <a href="/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-Parsing.html#t:ParserState">ParserState</a><a href="src/Yesod-Markdown.html#yesodDefaultParserState" class="link">Source</a></p><div class="doc"><p>Pandoc defaults, plus Smart, plus ParseRaw
</p></div></div><h1 id="g:4">Form helper
</h1><div class="top"><p class="src"><a name="v:markdownField" class="def">markdownField</a> :: RenderMessage master <a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Types.html#t:FormMessage">FormMessage</a> => <a href="/usr/share/doc/libghc-yesod-form-doc/html/Yesod-Form-Types.html#t:Field">Field</a> sub master <a href="Yesod-Markdown.html#t:Markdown">Markdown</a><a href="src/Yesod-Markdown.html#markdownField" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|