4 ms·
I have documented a moderately complex package in RST [0]/[1] and another in MDX (and a mix of MD & JS) [2]/[3] and have tons of $company docs written in MD. M
by dfee 7y ago
I have documented a moderately complex package in RST [0]/[1] and another in MDX (and a mix of MD & JS) [2]/[3] and have tons of $company docs written in MD.
My thought is that RST is probably closer on the spectrum to LaTeX (despite still being far away) as it’s a more powerful syntax with a more esoteric format.
If you’re a sole contributor or want to limit your contributors to those who know or have the patience to learn this, then sure, use RST.
Otherwise, documentation is a team sport. Write in whichever format will let people get ideas down fastest and can most easily be coerced it formatted text. Right now, the best option for that is MD.
These aren’t algorithms, so trade power for participation.
[0] https://github.com/dfee/forge/tree/master/docs https://github.com/dfee/forge/tree/master/docs
[1] http://python-forge.rtfd.io/ http://python-forge.rtfd.io/
[2] https://github.com/dfee/forge https://github.com/dfee/forge
[3] https://dfee.github.io/rbx https://dfee.github.io/rbx