gollum
一个基于 Git 的简单 Wiki 系统，用文本文件管理页面，自带网页编辑和版本控制。
智能下载
前往项目主页
该项目暂未提供安装包，请直接访问源代码仓库
把 Wiki 直接存进 Git 仓库，本地编辑，自动版本管理。
核心功能
- 基于 Git：所有页面都是 Git 仓库中的文本文件，天然拥有版本历史、回滚和分支管理
- 多种标记语言：支持 Markdown、RDoc、AsciiDoc、MediaWiki、Textile 等十余种格式
- 兼容 GitHub/GitLab：可直接克隆远程 Wiki 仓库，离线编辑后推送同步
- 内置网页编辑器：无需额外工具，浏览器即可创建和编辑页面
- 高级功能：支持 Mermaid/PlantUML 图表、数学公式、BibTeX 引用、CriticMarkup 注释、宏、重定向和 RSS 订阅
避坑指南
- •Windows 上必须使用 JRuby，普通 Ruby 无法运行；安装前请确保 Git 已配置；部分标记语言渲染器（如 AsciiDoc、MediaWiki）需要额外安装对应的 gem 或依赖；默认监听 4567 端口，注意防火墙设置；首次使用建议阅读官方 Wiki 了解配置选项。
适用场景
- 团队内部知识库：配合 Git 服务器（如 GitLab、GitHub）搭建私有 Wiki
- 个人笔记系统：用 Git 管理笔记，随时回溯和同步
- 项目文档：将技术文档、API 说明以 Wiki 形式托管在 Git 仓库中
- 离线文档编辑：克隆远程 Wiki 到本地，在没有网络的环境下编辑和预览
详细介绍
Gollum 是一个基于 Git 的轻量级 Wiki 系统。它不使用数据库，而是将所有页面作为纯文本或标记文件存储在 Git 仓库中。你可以用自己喜欢的编辑器或内置网页界面编辑页面，每次修改都会自动进行版本管理。Gollum 支持 Markdown、RDoc、AsciiDoc、Creole、MediaWiki、Org、Pod、ReStructuredText、Textile 等多种标记语言。它兼容 GitHub 和 GitLab 的 Wiki，因此你可以克隆远程 Wiki 仓库、本地编辑后再推送。高级功能包括 Mermaid/PlantUML 图表、BibTeX 引用、CriticMarkup 注释、数学公式（KaTeX/MathJax）、宏、重定向和 RSS 订阅。Gollum 在类 Unix 系统和 Windows（通过 JRuby）上均可运行，支持作为 Ruby Gem、Docker 容器或 Java WAR 文件部署。
常见问题与排障 (1)
故障排除为什么Gollum会将我代码块中的尖括号渲染为宏，如何修复？
Gollum 可能会误解包含尖括号的内联代码块（例如 <address>[;<options>]）为 Gollum 宏。要避免此问题，请将代码块放在单独的行中，使用独立行上的三个反引号：
[<device>][=<mac-address>]:<address>[;<options>]
这样可以阻止 Gollum 将内容解析为宏。如果使用 Docker 镜像，则无需更改 gem；这是一种格式解决方法。
标签
快速上手
安装软件
双击下载的安装程序，按提示完成安装
步骤 1：确保已安装 Ruby（推荐 2.5+）或 Docker/Java（选择一种方式）
步骤 2：安装 Gollum：gem install gollum（Ruby 方式）或 docker pull gollumwiki/gollum
步骤 3：进入一个已初始化的 Git 仓库目录，运行 gollum .
- 步骤 1：确保已安装 Ruby（推荐 2.5+）或 Docker/Java（选择一种方式）
- 步骤 2：安装 Gollum：gem install gollum（Ruby 方式）或 docker pull gollumwiki/gollum
- 步骤 3：进入一个已初始化的 Git 仓库目录，运行 gollum .
暂未获取到校验码
该项目暂未在 GitHub Release 页面提供 SHA-256 校验码
SHA256 校验码
暂无校验码
建议从 GitHub Releases 页面直接下载，并自行核对文件完整性
本平台所有 SHA-256 校验码均提取自项目在 GitHub 官方 Release 页面发布的文件，未做任何修改。你可以通过 GitHub Releases 页面自行验证。
开源透明
查看 GitHub 源码卸载说明
若通过 Gem 安装，执行 gem uninstall gollum；若通过 Docker，执行 docker rmi gollumwiki/gollum，并删除相关容器；若通过 WAR 包，删除 jar 文件即可。
无额外依赖
下载后即可直接使用，无需安装其他运行环境
遇到问题？查看下方 FAQ
1 FAQ