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

[Michael Snoyman]

It supports ```language blocks, but not autolink detection. I have not
fully documented which features are supported. I also haven't done any
performance analysis versus other tools, simply because my goal is in no
way high efficiency. It is fast enough for my use cases, and I don't intend
to spend significant time optimizing unless a problematic level of
inefficiency is discovered. If anyone else wants to put together
benchmarks, I'll be happy to lend some guidance.


On Mon, Apr 8, 2013 at 12:50 PM, Niklas Hambüchen <mail at nh2.me> wrote:

> Could you elaborate a bit on which markdown features you support (or
> even better: write it into your module haddocks)?
>
> Thinks like
> - autolink detection
> - ```language blocks?
>
> Also, you build on performance-oriented libraries - it would be cool if
> you could make a small benchmark comparing with the standard
> C/Python/Ruby parser implementations; AFAIK there is a standard Markdown
> test suite that this could run against.
>
> Concerning the project proposal:
>
> I especially find the last feature useful for programming documentation,
> and would love to have them in a potential haddock succesor. I was also
> pleasantly surprised that pandoc seems to handle all of this (even with
> code syntax highlighting).
>
> On 05/04/13 02:10, Michael Snoyman wrote:
> > 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/20130409/90595618/attachment.htm>