DEV Community

Discussion on: Documentation automation

 
elcotu profile image
Daniel Coturel

This indeed helps me a lot. If you don't mind the question, why do you prefer Markdown for short documents? Is there a lack of functionality that makes it unsuitable for large documents?

Saludos,

Thread Thread
 
zerok profile image
Horst Gutmann • Edited

That’s pretty much it. Markdown itself only supports basic markup like bold, italic and linking, but if you, for instance, want to mark things like keyboard shortcuts, menu entries etc. (which is quite common in manuals and userguides), Asciidoc and Sphinx offer far more.

The technical term for the feature I’m referring to is “semantic markup”. For manuals etc. this is essential.

Markdown, on the other hand, has ether advantage that it is far more common, so onboarding new people is easier.