GitHub Pages Vs. Wiki
So, I'm trying to decide what would be a better tool to document my new GitHub project CanaryModPluginSeed. A simple pro-con approach yields the following:
- Anybody can update
- More distributed responsibility, more likely to get done
- Not interactive
- Not tied to the current version, though in retrospect, netiher are github pages
Github pages pros
- Can use generated content
- Still can distribute responsibility to those who happen to know how to use github
Github pages cons
- Less likely to get updated by someone other than me
- HTML by default, more work to do
After some effort, setting up Jekyll proved to be a pain. There's some way to use markup on github pages, but I don't know what I did that caused it not to work. I'm just going to focus on the readme style documentation for now.
I used github instructions on how to install Jekyll and all the related tools, but unfortunately, ran into problems with certificates, problems while using cygwin, and then finally problems with not having dev tools installed. We're close, but no cigar.