We use GitHub Wikis for planning and documentation. This makes sense for us because we use GitHub to manage almost all of our projects. Another major reason is that we prefer to use text files over binaries. Since GitHub Wikis support Markdown, we can easily create tables and checklists in our Wikis. Of course, that also means we can use Vim, Git and many of the other command line tools that we love.
For any repository hosted on GitHub, its wiki can be cloned by appending
.wiki at the end of the git URL. So, for our
energyviz repository, it
We like to organize our wikis, so we usually add
_Sidebar.md to it. This allows us to override the default sidebar by manually re-arranging the content of the wiki. Here is a sample
Since we use Vim, it helps to have syntax highlighting for Markdown. We can use Vundle to install Vim-Markdown plugin:
Vim should now properly identify our Markdown files.
Since we were already used to working with Jekyll, we wondered if there was an easy way for us to preivew our wiki pages locally before pushing them to GitHub. There are a couple of tools that can do this, and we found gfms to be the best one for us. gfms stands for Github Flavored Markdown Server (GFMS).
gfms is powered by NodeJS, so we can use npm to install it:
We can then cd into our wiki dir and fire it up:
One of the things we love about gfms is that it automatically refreshes the browser window when the file is saved.
You will notice that it writes out remaining API requests each time you save a file.
That is the number of requests you have remaining for unauthenticated requests. That is currently set at 60. You can check your limit with this command: