Unit tests for renderMarkdown in doctest format (#1000, #1001)

Author: andreasabel

Distribution/Server/Util/Markdown.hs

@@ -28,6 +28,13 @@ import System.FilePath.Posix  (takeExtension)
 import qualified Data.ByteString.Lazy as BS (ByteString, toStrict)
 import qualified Text.XHtml.Strict as XHtml
 
+-- Set up doctest to deal with bytestring literals.
+-- Need to import a suitable @instance IsString@ for @ByteString@.
+
+-- $setup
+-- >>> :set -XOverloadedStrings
+-- >>> import Data.ByteString.Lazy.Char8 ()
+
 -- HHtml wraps Html, and mostly behaves the same, except that
 -- relative links in images and urls have "src/" prepended.
 newtype HHtml a = HHtml { unHHtml :: Html a }
@@ -104,13 +111,27 @@ adjustRelativeLink url
   | otherwise = url
 
 -- | Render markdown to HTML.
+--
+-- >>> renderMarkdown "test" "Please send bug reports to [email protected]."
+-- <p>Please send bug reports to <a href="mailto:[email protected]">[email protected]</a>.</p>
+-- <BLANKLINE>
+--
+-- >>> renderMarkdown "test" "Published to http://hackage.haskell.org/foo3/bar."
+-- <p>Published to <a href="http://hackage.haskell.org/foo3/bar">http://hackage.haskell.org/foo3/bar</a>.</p>
+-- <BLANKLINE>
+--
 renderMarkdown
   :: String         -- ^ Name or path of input.
   -> BS.ByteString  -- ^ Commonmark text input.
   -> XHtml.Html     -- ^ Rendered HTML.
 renderMarkdown = renderMarkdown' (renderHtml :: Html () -> TL.Text)
 
 -- | Render markdown to HTML, prefixing relative links with @src/@.
+--
+-- >>> renderMarkdownRel "test" "See [world file](world.txt)."
+-- <p>See <a href="src/world.txt">world file</a>.</p>
+-- <BLANKLINE>
+--
 renderMarkdownRel
   :: String         -- ^ Name or path of input.
   -> BS.ByteString  -- ^ Commonmark text input.