I still use md for READMEs and gists and whatnot, I guess my point is, different tools for different jobs, if you have to pull weeds in your garden use a spade, if you have to do it for a field use a machine, or something.
Hint: This is rhetorical. https://docutils.sourceforge.io/FAQ.html#is-nested-inline-ma...
> Not currently, no. It's on the to-do list (details here), and hopefully will be part of the reStructuredText parser soon. At that time, markup like this will become possible:
Here is some *emphasized text containing a `hyperlink`_ and
``inline literals``*.
So absolutely valid syntax just doesn’t work. Aaaand that todo list entry dates back to 2001.(I know, I know, instead of complaining I should submit a fucking patch. Unfortunately fixing reST is one of the least urgent things on my should-submit-a-patch list.)
You can't make section headers with ##, no?
More importantly in RST you can't easily manage several levels of headings. You're limited to 2 or 3, and have to remember which underline character you used for that level.
There's not a suggested or standard order, so yes there's some mental overhead in deciding which header styles you want to be which level, but a lot of projects tend to have a "lint" guide for that at this point. For instance a lot of projects (and Sphinx recommends) follow the Python Style Guide:
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
(You may be confusing Markdown's/CommonMark's own less popular Setext-style headers which only support underline and = for first level and - for second level header.)= - ^ ~
Markdown has a lot of implementations (with some fragmentation, granted) and is adopted by many diverse projects outside the python sphere.
Pandoc supports rST.
I write Elixir docs on my projects because it's easy pretty and obsessively making my docs prettier hits that spot in my brain.
Extreme example:
https://hexdocs.pm/zigler/Zigler.html
Where I've automatically marshalled zig code into the elixir documentation (https://hexdocs.pm/zigler/beam.html#get_f32/2) and you can click the slash in the upper right of the function header to link to the code on Github.
As a bonus, check it out on mobile and compare it to this on mobile:
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/exam...
ReST for life!