GitHub + Gollum 搭建个人Wiki

Posted by koyo on February 5, 2016

主要参考杨志平的 这篇 文章。

配置步骤

1) 为自己的.github.io项目开通wiki页面

open wiki 并通过Web端添加一个默认的Wiki页 open wiki

2) 把wiki项目clone下来
git clone git@github.com:koyo922/koyo922.github.io.wiki.git wiki
cd wiki
3) 安装,开分支,并启动Gollum
sudo gem install golum -n /ussr/local/bin
git checkout -b dev #签出到dev分支上
gollum --allow-uploads -r dev #看dev分支上的内容
  1. Gollum等Ruby模块在Mac OSX 10.11上比较麻烦,详见这篇关于Jekyll配置的文章
  2. dev分支只是为了方便管理,名称无所谓。因为Gollum上的内容要提交之后才能看到,不想每次改动都随便提交到master分支上。
4) 正常使用

按照这篇文章讲的,只用最基本的Markdown功能即可。 注意对比自己的本地Gollum网页GitHub上的Wiki页; 前者支持拖拽上传文件,实时预览,比较方便 拖拽文件上传 而且,拖拽到的地方会自动生成相应的引用 拖拽后自动填充的引用 可以看到,相应的文件已经自动上传到相应位置了 上传完毕

与之类似GitHub上的Wiki页在编辑的时候,可以翻到预览页,也差不多;对于小白用户比较友好。

Gollum不支持kramdown的高级用法,跟GitHub上的Wiki差不多,只支持最基本的Markdown语法, 不要试图折腾格式