gitlab 内建了一个 wiki 系统,称为 gollum,可以通过 git 下载和上传撰写 wiki 文档,就好像在编程一般。

安装使用步骤

步骤 1:安装依赖项 icu4c

1
$ sudo brew install icu4c

步骤 2:更新 RubyGems,建议 2.6.x

1
2
3
4
# 更新版本
$ gem update --system
# 查看版本
$ gem -v

步骤 3:更换 gem 的安装源

1
2
3
4
# 去除原安装源,添加中国镜像安装源
$ gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
# 查看修改后的安装源,确保只有 https://gems.ruby-china.com/
$ gem sources -l

步骤 4:安装依赖项 charlock_holmes

1
$ sudo gem install charlock_holmes -- --with-icu-dir=/usr/local/opt/icu4c

步骤 5:安装 gollum

1
2
3
4
5
6
7
8
####################################
# 以下命令 2 选 1,视自己情况而定
####################################

# 如果是公司电脑,对 /usr/bin 做了写权限限制的,自己无权限的情况
$ sudo gem install gollum -n /usr/local/bin
# 如果没有任何权限限制
$ sudo gem install gollum

步骤 6:clone wiki 仓库到本地
假设你有一个 gitlab 项目,你可以进入到 wiki,记下 wiki 子仓库地址并 clone 到本地。

1
$ git clone git@gitlab.xxx.com:username/repoName.wiki.git

步骤 7:进入本地 wiki 项目文件夹并启动 gollum

1
2
3
4
5
6
$ cd repoName.wiki
$ gollum .
[2018-09-05 10:20:25] INFO WEBrick 1.3.1
[2018-09-05 10:20:25] INFO ruby 2.3.3 (2016-11-21) [universal.x86_64-darwin17]
== Sinatra (v1.4.8) has taken the stage on 4567 for development with backup from WEBrick
[2018-09-05 10:20:25] INFO WEBrick::HTTPServer#start: pid=83219 port=4567

可以看到输出,监听端口号是 4567

步骤 8:打开 gollum 启动的本地服务器并编写 md 文档
浏览器访问 http://localhost:4567,具体端口号看上一步 gollum 打印出的信息。
然后就可以愉快地编写了,写完文档按保存后,gollum 会自动执行 git commit 操作,但是不会提交到远程仓库。

步骤9:提交改动到远程仓库
命令行执行:

1
$ git push origin master