Using Markdown to write Documentation

I absolutely cannot stand writing documentation. Well, that’s kind of a lie; I don’t mind the actual writing, but I get too hung up on trying to make it look pretty. If you—the reader—write your own, then maybe you’ll know what I mean. One of the best things about writing docs that’ll be hosted on-line is that the format will be based upon the site that it lives in. Take Github for example; all documentation up there looks the same. This is because they’re all written in Markdown. Markdown is a language syntax that standardises formatting which allows a writer to focus on the content that’s being written. If you’ve never seen a Github readme, check out a few: ...

28 September 2015 · 3 min