<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Apr 4, 2013 at 7:49 PM, Johan Tibell <span dir="ltr"><<a href="mailto:johan.tibell@gmail.com" target="_blank">johan.tibell@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">Hi all,<br>
<br>
Haddock's current markup language leaves something to be desired once<br>
you want to write more serious documentation (e.g. several paragraphs<br>
of introductory text at the top of the module doc). Several features<br>
are lacking (bold text, links that render as text instead of URLs,<br>
inline HTML).<br>
<br>
I suggest that we implement an alternative haddock syntax that's a<br>
superset of Markdown. It's a superset in the sense that we still want<br>
to support linkifying Haskell identifiers, etc. Modules that want to<br>
use the new syntax (which will probably be incompatible with the<br>
current syntax) can set:<br>
<br>
{-# HADDOCK Markdown #-}<br>
<br>
on top of the source file.<br>
<br>
Ticket: <a href="http://trac.haskell.org/haddock/ticket/244" target="_blank">http://trac.haskell.org/haddock/ticket/244</a><br>
<br>
-- Johan<br>
<br>
_______________________________________________<br>
Haskell-Cafe mailing list<br>
<a href="mailto:Haskell-Cafe@haskell.org">Haskell-Cafe@haskell.org</a><br>
<a href="http://www.haskell.org/mailman/listinfo/haskell-cafe" target="_blank">http://www.haskell.org/mailman/listinfo/haskell-cafe</a><br>
</blockquote></div><br></div><div class="gmail_extra">+1</div><div class="gmail_extra"><br></div><div class="gmail_extra" style>In case it can be useful in any way for this project, my markdown package[1] is certainly available for scavenging, though we'd likely want to refactor it to not use conduit (I can't imagine conduit being a good dependency for Haddock).</div>
<div class="gmail_extra" style><br></div><div class="gmail_extra" style>[1] <a href="http://hackage.haskell.org/package/markdown">http://hackage.haskell.org/package/markdown</a></div></div>