Creating Documentation With Flatdoc

Creating WeIO Documentation With Flatdoc

Our primary documentation is accessible from WeIO official site: http://we-io.net/ under Resouces/Documentation. Now, here is a tricky part - whole documentation is written in Flatdoc: http://ricostacruz.com/flatdoc/. Flatdoc corresponds to our philosophy of web app, and is a way to have beautiful 3 column documentation, while still keeping all the docs in human-readable Markdown format (http://en.wikipedia.org/wiki/Markdown). You can read more about it here: https://tommcfarlin.com/documentation-with-markdown/.

Markdown itself is really useful way of notation, created by famous Aaron Swartz (http://en.wikipedia.org/wiki/Aaron_Swartz), and the great way to create various types of formats while keeping your site in something that resembles to wiki - so you can actually read these files. With pandoc (http://johnmacfarlane.net/pandoc/), it can be easily transferred to any possible format in the world.

Anyway, here is the procedure:

• Fork weioDoc from here: https://github.com/nodesign/weioDoc and clone it from your fork (as usual)
• Go to the weioDoc directory and start the simple HTTP server in there:

drasko@Lenin:~/nodesign/weioDoc$ python -m SimpleHTTPServer
Serving HTTP on 0.0.0.0 port 8000 ...

• Point your browser to http://localhost:8000/gettingStarted.html

As you see, Flatdoc has to be served - i.e. you can not just browse HTML files. This is because it parses .md files "on the fly" when they are served and accessed. I use the simplest possible HTTP server that comes with Python (http://www.linuxjournal.com/content/tech-tip-really-simple-http-server-python)