[Haskell-cafe] Superset of Haddock and Markdown

Roman Cheplyaka roma at ro-che.info
Fri Nov 18 09:06:59 CET 2011

* Johan Tibell <johan.tibell at gmail.com> [2011-11-17 21:09:15-0800]
> Hi all,
> I spent some time today documenting a library and the experience left me
> wanting a better markup language. In particular, Haddock lacks:
>  * markup for bold text: bold text works better than italics for emphasis
> on computer monitors.
>  * hyperlinks with anchor texts: having the actual URL rendered inline with
> text hurts readability.
> Could Haddock markup be extended to also include some Markdown features?
> The new features could be hidden behind a flag so old documentation doesn't
> get unwanted markup (e.g. if it uses *...* to not mean bold).
> P.S. This good make a good weekend hack that shouldn't be too difficult.

Sounds awesome!

Maybe have a switch that enables markdown and disables markup-related
features of haddock (everything except linking to identifiers/modules, I
believe), so that we don't affect existing docs. Then make it possible
to pass this flag through cabal.

Roman I. Cheplyaka :: http://ro-che.info/

More information about the Haskell-Cafe mailing list