Ticket #244 (new enhancement)

Opened 2 years ago

Last modified 14 months ago

Add Markdown support

Reported by: tibbe Owned by:
Priority: major Milestone:
Version: 2.11.0 Keywords:
Cc: michael@…

Description

Markdown has become the standard markup for writing programming documentation (and blog posts and so on). It would be nice if Haddock could support a superset of Markdown (i.e. with support for identifier references and so forth) via a pragma:

{-# HADDOCK Markdown #-}

That way we could produce much richer docs, containing tables, bold text, section headers (without having to add those headers to the export list), etc.

Change History

Changed 2 years ago by waern

This is a great idea that many people have proposed before but no-one has taken a stab at. It would be a good SoC project.

Changed 2 years ago by snoyberg

  • cc michael@… added

Changed 20 months ago by Fūzetsu

  • owner set to Fūzetsu
  • status changed from new to assigned

Being done as part of GSOC

Changed 14 months ago by Fūzetsu

  • owner Fūzetsu deleted
  • status changed from assigned to new

Ended up not doing this as part of GSOC, see haskell-café for details

Note: See TracTickets for help on using tickets.