wiki

gollum:轻量级的wiki系统

gollum 是什么?

gollum的readme上有句最简单的描述很直白:A git-based Wiki。

个人认为github,jekyll,gollum可以并称为码农的三大神器,github用来敲代码,jekyll用来写技术博客,gollum用来搭建自己的知识管理wiki系统。很巧合的是部门用gollum也有两年时间了,不过以前都是直接用,没有仔细看过手册,趁十一期间有时间简单搭了一套玩玩。

简单来讲gollum有以下四个优点:

  • 轻量级,但结构和功能完整
  • 使用Markdown语法
  • 可提供网页服务
  • 使用git进行内容控制

尤其是第四点,完全没有抵抗力啊~

gollum 的安装

gollum的安装很简单,尤其是在ubuntu 14.04上:

sudo apt-get install ruby1.9.1 ruby1.9.1-dev make zlib1g-dev libicu-dev build-essential git
sudo gem install gollum

或者选择源代码安装:

git clone https://github.com/gollum/gollum
cd gollum
bundle install

而后初始化git目录,在git的目录执行

gollum --css --allow-uploads --mathjax --h1-title	

以上使用了一些参数,分别是使用自定义 custom.css 文件(在git初始化目录),增加上传功能,支持 LaTeX 公式,markdown的一级标题为全文标题。

在浏览器中访问以下地址来创建wiki内容:

http://localhost:4567

我简单编辑了home页面,大概长得是这个样子:

这个页面其实是markdown的文件

# xxx部门的wiki

## [[推荐系统|/RecHome]]

Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository (either bare or regular) of a specific nature:

1. A Gollum repository's contents are human-editable, unless the repository is bare. 
2. Pages are unique text files which may be organized into directories any way you choose. 
3. Other content can also be included, for example images, PDFs and headers/footers for your pages.

## This is second

如图片所示,一般的功能诸如home,新建,重命名,编辑,历史,最近的改变等均有。

gollum有完整的wiki语法结构,可以直接参考gollum的wiki,这里就不做赘述,简言之:非常完备值得拥有。

最后在这里可以拿到自定义的 css文件

gollum的一些注意点

  1. gollum命令必须在git目录下使用
  2. 使用git来提交内容时一定要commit之后才会生效
  3. git必须在master分支提交
  4. wiki的目录结构最好事先设计好,否则文件会非常乱
Permanent link http://bjt.name/2015/10/gollumOct 01, 2015