Use Markdown for documentation
Rico Sta. CruzFebruary 19, 2015 The most universal documentation "format" is a bunch of Markdown files inside a project's doc/
directory. Here are some projects that follow that convention:
In my opinion, "a bunch of Markdown files" is good because:
- It's easily viewable in GitHub
- It can be made into a Jekyll (GitHub pages) site easily
- It can be made into a Sphinx site easily
- It's a common documentation format that you can get some tools to generate to