Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)

[Ulrich Mueller]

>>>>> On Thu, 07 Oct 2021, Matthew Marchese wrote:

> I also like the idea of markdown files or RST files living in
> gentoo::. I personally find RST to be a bit more challenging to write,
> but it's simple enough to learn and we 'already have RST to HTML
> conversion on www.g.o for GLEPs. GitHub will render either file format
> in browser. Not sure about all the other Git* sites.

> Apparently the MD and RST formats are somewhat interchangeable if one
> does not go too crazy on formatting:
> https://gist.github.com/javiertejero/4585196

To add to this, here are two excellent articles comparing the two
formats:

https://www.zverovich.net/2016/06/16/rst-vs-markdown.html
https://eli.thegreenplace.net/2017/restructuredtext-vs-markdown-for-technical-d$

Given that we already use RST elsewhere and that it is well supported by
docutils (and our own docutils-glep), that's the format I'd personally
prefer.

Otherwise, the picture in the first article pretty much summarizes it.
:)

Ulrich