4 ms·
Markdown is an ok choice for documentation. Poor documentation of a project is not due markdown being used. Good documentation requires different types of docs
by mfer 7y ago
Markdown is an ok choice for documentation.
Poor documentation of a project is not due markdown being used. Good documentation requires different types of docs targeting the different types of docs and different types of users.
When it comes to the ability to capture things in docs there's more that's useful than markdown can represent. For example, notes, warnings, etc. Tools like hugo have come up with work arounds that are outside of markdown.
Just saying... some things like asciidoc allow capture of richer information.
Still, the format isn't going to make the docs good or bad.