gollum 是github的使用的一个基于markdown的 wiki系统的构造工具,简单实用。
gollum直接和git集成不需要数据库,你可以选择在Web页面撰写文档,也可以用你喜欢的markdown工具编辑文档在命令行进行提交,用来搭建自己的知识管理wiki系统。 “markdown+git = wiki” 这对程序员来讲绝对是最优(zhe)雅(teng)的方式。
类似于博客系统jekyll和hexo的功能。写博客与写wiki的区别是,前者在于创作,后者在于对知识的整理,非原创的文章适合使用wiki来整理归档。
优点:
- 轻量级,但结构和功能完整
- 使用Markdown语法
- 可提供网页服务
- 使用git进行内容控制
运行环境
系统版本:OS X 10.11.3
包管理器:Homebrew 0.9.5
Ruby版本:ruby 2.0.0p645 (2015-04-13 revision 50299) [universal.x86_64-darwin15]
安装gollum
sudo brew install icu4c |
如果长时间安装不上,可能是因为GFW导致,更换为淘宝镜像地址,重新安装即可
sudo gem sources --remove https://rubygems.org/ |
安装成功后输入以下命令,如果返回版本号则安装成功gollum --v
Gollum 4.0.1
Clone Wiki到本地
先在github
上建立一个项目仓库,并开通wiki,初始化一个wiki主页
复制仓库的地址,并在后台添加 wiki
Repositories地址
gitcom:gitlt/qkfe.git . |
wiki地址
git@github.com:gitlt/qkfe.wiki.git |
运行
git clone git@github.com:gitlt/qkfe.wiki.git wiki |
提示 INFO WEBrick::HTTPServer#start: pid=70851 port=4567
在浏览器打开地址 127.0.0.1:4567
即可看到如下操作界面
添加新的文章,进行wiki
目录,执行命令推送到github上就能完成更新了
cd wiki |
如果提示提交失败,请检查 是否github没有添加本地的SSH keys, 是否github项目中没有初始化wiki,添加一个wiki页面。