Ben Chuanlong Du's Blog

It is never too late to learn.

Markdown vs RestructureText vs MyST for Documentation

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

Comparison

  1. Compared to Markdown, RestructuredText is more fully-featured, much more standardized and uniform, and has built-in support for extensions. However, ReStructuredText is also criticized for its complex and confusing syntax. The toolchains for ReStructuredText (Sphinx) is also more complicated to use than Markdown equivalent tools. MySt is an extension from CommonMarkdown with goodies introduced from RestructuredText. The jupyter-book project supports MySt syntax.

References

https://myst-parser.readthedocs.io/en/latest/

https://eli.thegreenplace.net/2017/restructuredtext-vs-markdown-for-technical-documentation/

https://www.jungledisk.com/blog/2017/01/20/restructuredtext-vs-markdown/

https://www.zverovich.net/2016/06/16/rst-vs-markdown.html

https://predictablynoisy.com/2020-01-22-rst-thoughts

Comments