Add Markdown support

[ghc-mirror]

Original reporter: @tibbe

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.

[ghc-mirror]

Original reporter: david.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.

[ghc-mirror]

Original reporter: fuuzetsu@

Being done as part of GSOC

[ghc-mirror]

Original reporter: fuuzetsu@

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

[hvr]

Relevant further reading:

• https://mail.haskell.org/pipermail/haskell-cafe/2013-April/107808.html
• https://mail.haskell.org/pipermail/haskell-cafe/2013-August/110037.html
• http://fuuzetsu.co.uk/blog/posts/2013-08-30-why-Markdown-in-Haddock-can't-happen.html

[simonpj]

Thanks!

From: Herbert Valerio Riedel [mailto:notifications@github.com] Sent: 16 November 2016 17:53 To: haskell/haddock haddock@noreply.github.com Subject: Re: [haskell/haddock] Add Markdown support (#244)

Relevant further reading:

• https://mail.haskell.org/pipermail/haskell-cafe/2013-April/107808.htmlhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmail.haskell.org%2Fpipermail%2Fhaskell-cafe%2F2013-April%2F107808.html&data=02%7C01%7Csimonpj%40microsoft.com%7Cf0f2858373e44225510e08d40e495b7c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636149155612591232&sdata=Lr%2FHfLXQ3NNk3MqIBbH2eIAyqhkhUlFoCJ%2FNZSZ7keU%3D&reserved=0
• https://mail.haskell.org/pipermail/haskell-cafe/2013-August/110037.htmlhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmail.haskell.org%2Fpipermail%2Fhaskell-cafe%2F2013-August%2F110037.html&data=02%7C01%7Csimonpj%40microsoft.com%7Cf0f2858373e44225510e08d40e495b7c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636149155612601240&sdata=SJcuqA%2FdGsOJfZ0d6Sx9x5IKbfLBeVF45jBdM7qUk4s%3D&reserved=0
• http://fuuzetsu.co.uk/blog/posts/2013-08-30-why-Markdown-in-Haddock-can't-happen.htmlhttps://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Ffuuzetsu.co.uk%2Fblog%2Fposts%2F2013-08-30-why-Markdown-in-Haddock-can%27t-happen.html&data=02%7C01%7Csimonpj%40microsoft.com%7Cf0f2858373e44225510e08d40e495b7c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636149155612601240&sdata=QSxMK6LMZe9fVaGJR%2B1dppNlV8TwnoBTAzAU2%2F75te8%3D&reserved=0

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fhaskell%2Fhaddock%2Fissues%2F244%23issuecomment-261019664&data=02%7C01%7Csimonpj%40microsoft.com%7Cf0f2858373e44225510e08d40e495b7c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636149155612601240&sdata=F%2FSC%2F5quHdCLjmNzIhz%2BI8baaX0SJTtdNUziP4uqMUY%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAjse1KXthew-mBtdZuMgJbcPJV3HhPmks5q-0LmgaJpZM4B5Q51&data=02%7C01%7Csimonpj%40microsoft.com%7Cf0f2858373e44225510e08d40e495b7c%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636149155612601240&sdata=GSRN1uUoh7OLs%2ByV4BYF1%2BtRWHsijokOPNjwMBHfWBE%3D&reserved=0.

[sgraf812]

See #794 and #729; the chances that we'll see a markdown backend in the near future aren't bad.