2 ms·
Well, yes. Markdown is the right tool for some documentation. For other documentation, it isn't. Use the right tool for the job. Markdown is a great format for
by Veen 7y ago
Well, yes. Markdown is the right tool for some documentation. For other documentation, it isn't. Use the right tool for the job.
Markdown is a great format for writing basic HTML documents. It sucks for writing books or complex documents, as Matthew Butterick has argued [0]. But that's only a problem if you try to write books or complex documents in Markdown.
[0]: https://docs.racket-lang.org/pollen/second-tutorial.html https://docs.racket-lang.org/pollen/second-tutorial.html
- hak8or 7y agoI used markdown for my documentation of a embedded liux system years back (https://brainyv2.hak8or.com/ https://brainyv2.hak8or.com/) and have been very pleased. While it's not a book, it's also not a single page document. The rust official docs are also written in markdown and thrown at mdbook (https://rust-lang.github.io/mdBook/ https://rust-lang.github.io/mdBook/) to generate documentation of a similar style, but it's much more book like. I am pretty much all in for markdown based documentation for almost everything. It does what I need and nothing more. If I need more control over styling, that's a different story, but thankfully almost all my use cases are good enough without such control.