介绍

Gollum 是一个基于 Git 的 Wiki 软件，GitLab 自带的 Wiki 就是 Gollum。

可以使用 Gollum 作为本地预览工具使用，方便管理团队 Wiki。

配置

环境

  • Gollum 4.1.4
  • macOS 10.14.4
  • ruby 2.4.2p198

安装

建议使用国内的 ruby-china 源，否则下载速度非常慢，有可能根本下载不了。

1
2

gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
gem install gollum

运行

1
2

cd your_wiki_git_dir
gollum

注意：gollum 必须在 Git 仓库的根目录下运行，否则会报 Gollum::InvalidGitRepositoryError 错误。如果没有可以使用 git init 创建一个 Git 仓库。

使用

如果团队使用 GitLab 管理项目，那么可以顺便使用 GitLab 项目网页中的 Wiki，以下介绍团队使用的一点技巧。

规范

  1. 使用 Markdown 语法写文档，其实有很多种格式，但这是最简单通用的格式。
  2. 文件名使用连字符分隔；全部小写；扩展名 .md；

定义统一的规范是为了方便管理，规范是什么样的不重要，关键是统一。

Markdown 技巧

只需要掌握最基本的技巧，就可以应付工作中的 wiki。

引用其他文档

1

[title](cannonical-page-filename)

使用文档的文件名（不包含扩展名 .md）作为 cannonical-page-filename

引用图片

将图片放到 assets 目录下，文件名前半部为当前文档的文件名，后半部为自己自定义的名字。

使用下面的语法插入图片：

1

![image text](assets/image-filename)

image-filename 包含扩展名

加入自动生成的目录

在想要放置目录的地方加入如下标记：

1

[[_TOC_]]

参考资料