免费构建个人WIKI知识库

发布于

0x01 背景

平时专业搬砖人士要与各种文档打交道，每天都有新的“知识点”，这些知识点之后会有机被重复拿出来使用，网上的问答系统，wiki也很多，数据放在某些平台有时还是不放心，不一定那天这平台没了，无论是内容无法找回，还是需要迁移知识库都是很麻烦的事情。

需要一个既可以在本地使用， 又同时可以在互联网上编辑操作的wiki系统，并且不需要我们额外的购买主机服务器。

gollum这个软件就可以做到这一点，gollum是基于ruby生态的，需要安装ruby gem，ruby环境安全这里就不介绍了。

大家都知道github是一个代码托管平台，其实有github还可以托管网站git-pages，还有wiki系统，我们可以像管理代码一样管理wiki文档。

0x02 Github Wiki

比如一个github工程项目的地址，如下：

代码语言：javascript
复制
git@github.com:shengnoah/luaren.git

这个工程的wiki地址是，如下：

代码语言：javascript
复制
git@github.com:shengnoah/luaren.wiki.git

剩下的操作就是编辑wiki的markdown文本。

0x03 Gollum安装

gollum的相关软件安装，如下：

代码语言：javascript
复制
代码语言：javascript
复制
gem install gollum
gem install github-markdown

gollum的原理是在用户本地，利用ruby系统创建一个WEB版的wiki服务，让用户可以在本地上通过网页对wiki的markdown文件进行操作，然后将操作的文件上传到github上，这样用户可以github项目的wiki页面，看到你本地操作相关结果。

0x04 Gollum的启动与wiki创建

下载github的项目的wiki(需要在工程里开通wiki功能)

代码语言：javascript
复制
git clone git@github.com:shengnoah/luaren.wiki.git
cd luaren.wiki
gollum

启动以上操作，就在本机创建了一个gollum的web wiki服务，监听的IP和端口是:

代码语言：javascript
复制
tcp://0.0.0.0:4567

0x05 总结

这个系统将github的wiki系统本地化，gollum让用户可以通过本地web的页，操作wiki的markdown文档，也可以让用户通过互联网上的github的用户项目里的的wiki页面进行文档的维护，直接在github的项目中对wiki文档进行操作，并且可以实现多人协作一起维护wiki文档。不需要购买主机空间只要你有github账号。

让用户可以做到线上，线下都能维护自己的wiki内容。

#github#git#开源#ruby