[Haskell-cafe] GSoC Project Proposal: Markdown support for Haddock

Michael Snoyman michael at snoyman.com
Thu Apr 4 20:10:15 CEST 2013

On Thu, Apr 4, 2013 at 7:49 PM, Johan Tibell <johan.tibell at gmail.com> wrote:

> Hi all,
> Haddock's current markup language leaves something to be desired once
> you want to write more serious documentation (e.g. several paragraphs
> of introductory text at the top of the module doc). Several features
> are lacking (bold text, links that render as text instead of URLs,
> inline HTML).
> I suggest that we implement an alternative haddock syntax that's a
> superset of Markdown. It's a superset in the sense that we still want
> to support linkifying Haskell identifiers, etc. Modules that want to
> use the new syntax (which will probably be incompatible with the
> current syntax) can set:
> {-# HADDOCK Markdown #-}
> on top of the source file.
> Ticket: http://trac.haskell.org/haddock/ticket/244
> -- Johan
> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe


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).

[1] http://hackage.haskell.org/package/markdown
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.haskell.org/pipermail/haskell-cafe/attachments/20130404/5278c9e4/attachment.htm>

More information about the Haskell-Cafe mailing list