Intro to Wiki Over Git - raisercostin/software-wiki GitHub Wiki

Sync

• Syc Wiki in your project via a submodule

Golum

• install jruby: https://github.com/jruby/jruby/wiki/GettingStarted
• install local gollum: jruby -S gem install gollum
  • still doesn't work on windows: https://github.com/gollum/gollum/wiki/Installation#windows

Resources

• https://nerds.inn.org/2014/05/19/applying-git-to-github-wikis/
• http://www.nomachetejuggling.com/2012/05/15/personal-wiki-using-github-and-gollum-on-os-x/
• https://github.com/blog/774-git-powered-wikis-improved
• http://albertomiorin.com/blog/2013/03/25/the-zen-of-wiki-with-gollum/

Alternatives

• github.com
  • --no free private repos
• gitlab.org
  • -- doesn't have a sidebar/toc for entire wiki
  • ++ has free private repos
• bitbucket.org
  • -- doesn't have a sidebar/toc for entire wiki
  • markdown syntax not compatible with github
  • ++ has free private repos

Others

• Golum syntax - not valid anymore since github has other fork.
  • https://github.com/github/gollum/wiki - Github runs wiki using gollum so here is the syntax.