[FFmpeg-devel] Documentation: proposed changes in the structure

Clément Bœsch u at pkh.me
Fri Aug 21 22:58:58 EEST 2020


On Fri, Aug 21, 2020 at 09:42:57PM +0200, Oneric wrote:
> On Fri, Aug 21, 2020 at 14:46:53 +0200, Timo Rothenpieler wrote:
> > Something like Markdown would come to mind. It should have all formatting
> > tools one needs for documentation.
> 
> Imho ReStructuredText would be better suited for documentation than Markdown, 
> while being similarly "text-like".
> Unlike Markdown, RST has a clear spec, supports automatic table of contents 
> and citations etc. While this might be a matter of preference, RST's tables 
> and hyperlinks are also better than Markdown's imho.

Markdown has a spec: https://spec.commonmark.org/

But you are correct that there are as many flavour as there are
implementations in practice.

[...]

Regards,

-- 
Clément B.


More information about the ffmpeg-devel mailing list