reStructuredText VS GitHub Flavored Markdown

Markup language: Markup language is used to write documents in a way that distinguishes them from plain text. Most SSGs utilize lightweight markup languages, such as Markdown. However, alternatives like AsciiDoc, Textile, and ReStructuredText are also used. These lightweight languages simplify content creation and are converted into HTML during the site generation process. - Source: dev.to / 7 months ago

Uses Sphinx, reStructuredText And the sphinx-rtd-theme for writing, building And rendering the documentation. Source: 8 months ago

If we're dreaming, ReStructed Text support. Source: about 1 year ago

You can always switch to rst¹ and sphinx² to produce html/pdf came join the dark side, we have tables³ :) 1. https://docutils.sourceforge.io/rst.html. - Source: Hacker News / over 1 year ago

ReStrutucturedText is still useful to look at for inspiration here. It had the concepts of extensible metadata ("field lists"), spans ("interpreted text"), and blocks ("directives"). Including things like applying metadata to spans (using essentially Footnotes to provide field lists to interpreted text sections, like but better than Markdown's reference style for hyperlinks which almost no one uses but were much... - Source: Hacker News / almost 2 years ago

Not sure quite what you mean. Are you asking "what should I put on GitHub" or "how to make it look pretty?" For the latter, check out https://docs.github.com/en/get-started/writing-on-github. Source: about 1 year ago