Re:Why I Prefer RST to Markdown
by 8organicbits on Thursday August 01, 2024 @01:56PM
(#41131716)
You're still using all or nothing thinking. If I wanted to see the diagram then I'd open `system-hierarchy.png` by navigating to that file and clicking on it. Besides, you rarely need to build a markdown file yourself; open it on Git[Hub|Lab] or open the project's web docs. You could prefer a .txt, but that can't display images at all.
[ Parent
| on HN ]
Markdown can't display images at all, either... Which is my point.
(you know you can write paths in a .txt file too?)
Re:Why I Prefer RST to Markdown
by bulletninja on Friday August 02, 2024 @04:01AM
(#41136964)
But you would have to invent or assume a format for that .txt, and markdown is easily rendered if needed
Invent a format? How about, "The system overview has been illustrated in images/system-overview.png"
We use markdown because it is plaintext and accessible. Oh, but you have to convert it yourself. How? Well every project is different but I'm sure you can find a Makefile somewhere in the project. Good luck!
Again, the point again is that markdown is not readable alone.
If it is, then a .txt is strictly superior. If it is not, then never, ever, present it as the final product. Always ship the generated artifacts. The only point you want to actually see the .md file is if you want to make changes to it. Is making changes the primary usecase for your markdown files? I'm going to assume, no.