[Haskell-cafe] Markdown extension for Haddock as a GSoC project
fuuzetsu at fuuzetsu.co.uk
Sun Apr 28 12:26:46 CEST 2013
-----BEGIN PGP SIGNED MESSAGE-----
On 28/04/13 00:08, Joe Nash wrote:
> Managed not to send to all:
> I think the reason markdown was the original suggestion was due to
> the fact it is a very widespread and popular syntax, and as Johan
> commented in the original thread, has to an extent "won". Having a
> consistent, standard documentation syntax for Haskell is of course
> important, but this project also seeks to standardise the syntax
> beyond Haskell.
I don't think standardising it beyond Haskell is the goal at all. I
think that coming up with Markdown that doesn't repeat the mistakes of
all the flavours out there is quite difficult in itself, but coming up
with such Markdown AND making it making it flexible enough to be of
any use with Haddock as is? I think it might be a little out of scope.
Extending Haddock itself and providing a writer (and a new reader) for
Pandoc will let you write Markdown if you please and then convert it
to (and from) many of the formats supported by Pandoc.
> It may be hedging our bets, as a lot could change and markdown
> could suddenly fall from fame, but I believe the large variety of
> opposing markup languages are failing to gain traction in
> comparison and it is indeed a safe bet.
While I don't think it will fall from fame overnight, it would be a
shame to restrict people to just using Markdown because that's how all
the extensions were implemented.
> If the flexibility of having it pandoc compatible is a desired
> feature, can this not be achieved through implementing markdown for
> haddock as well? Depending on what haddock specific features were
> required to be added to the superset, it may require only minimal
> changes to an existing markdown reader/writer in pandoc already.
It can, but the restriction comment applies here as well.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.19 (GNU/Linux)
-----END PGP SIGNATURE-----
More information about the Haskell-Cafe