I humbly suggest reStructuredText rather than Markdown, which is what is used by the Python community for documentation. Since it's specifically made for documentation it may be nicer. But, I don't want to spark a format argument.
There is also the Pandoc program, which is a universal-ish markup- language-converter, conveniently written in Haskell. Might be a place to start for this, regardless of the language chosen: http://www.johnmacfarlane.net/pandoc/ Simon Excerpts from Johan Tibell's message of 2013-04-04 09:49:04 -0700: > 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 [email protected] http://www.haskell.org/mailman/listinfo/haskell-cafe
