rosetta stone for converting text

[rkdarst]

Is your feature request related to a problem? Please describe.

It would be nice to have a "rosetta stone" of sorts, displaying rst and myst along side each other (possibly including a rendering of it). I have started making these myself, but having one authoritative source would be best. It is important to list things side-by-side, since whether it is good or not, at least some people will need to understand how to convert between them. It will also serve as a good quick reference for what is different than commonmark.

It's at least mentioned a bit in #146.

Describe the solution you'd like

I could make something myself, but I'm not sure if I would create the best format (for columns, etc) alone. If someone who has an opinion makes a template, I can fill in the most important things [that I use often...].

[welcome[bot]]

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

[choldgraf]

I guess this would probably be added somewhere around: https://myst-parser.readthedocs.io/en/latest/using/syntax.html

maybe add a section to each part there that shows a tabled with MyST markdown on left, and rST on right?

[chrisjsewell]

or use tabs 😄

[pradyunsg]

I did some of this in https://pradyunsg.me/furo/reference/.

[chrisjsewell]

Note https://github.com/executablebooks/rst-to-myst is now available that can convert (nearly) any RST to MyST Markdown. So that is in essence the authoritative source for conversions, and should be able to be used for auto-generation of this kind of documentation

[choldgraf]

I'd be a fan of auto-generating this, shouldn't be too hard to build something that programmatically builds a markdown table or something that uses the vocabulary from rst-to-myst to do the conversions. We could add it as a part of the myst-parser docs build so it's always up to date.