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

Iustin Pop iusty at k1024.org
Thu Apr 4 20:07:18 CEST 2013


On Thu, Apr 04, 2013 at 06:41:19PM +0100, Edsko de Vries wrote:
> Yes please!

+1 as well. I find the current syntax too restrictive…

iustin

> On Thu, Apr 4, 2013 at 5: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
> >

> _______________________________________________
> Haskell-Cafe mailing list
> Haskell-Cafe at haskell.org
> http://www.haskell.org/mailman/listinfo/haskell-cafe




More information about the Haskell-Cafe mailing list