给使用 Git 做版本控制的项目添加 Wiki

安装使用

安装 Ruby

Mac OS X:

$ brew install ruby

可使用如下命令检测是否安装成功(能够正常显示版本号则说明安装成功):

$ ruby -v

安装 Gollum

$ sudo gem install gollum

可使用如下命令检测是否安装成功(能够正常显示版本号则说明安装成功):

$ gollum --v

克隆 Wiki 项目

从 GitHub 或者 GitLab 上克隆项目 ProjectA 的 Wiki 项目到本地 ProjectA 的目录:

$ cd ProjectA
$ git clone git@gitlab.dxy.net:f2e/ProjectA.wiki.git
$ cd ProjectA.wiki

运行 Gollum 并且在本地编辑项目的 Wiki

$ gollum

访问http://127.0.0.1:4567/ 即可开始在浏览器中编写Wiki。


参考

gollum:给wiki插上git的翅膀

志遥 wechat
微信扫一扫,我在丁香园记公众号等你