Gollum快速上手教程3个命令搭建你的Git驱动Wiki【免费下载链接】gollumA simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.项目地址: https://gitcode.com/gh_mirrors/go/gollumGollum是一个用 Ruby 编写的开源Git 驱动 Wiki任何 Git 仓库指一下它就立刻变成一个带网页浏览、在线编辑、版本历史和页面对比的 Wiki——不需要数据库也不需要复杂部署。本文将带你用3 个命令搭建起自己的 Gollum Wiki并覆盖 Docker 部署、常用参数等进阶技巧零基础也能跟上。为什么选 Gollum✨Gollum 由 GitHub 团队的工程师打造就是 GitHub 上 Wiki 功能背后的那拨人把Wiki Git 仓库这件事做到了极致。核心卖点如下特性说明 纯 Git 存储每个 Wiki 页面就是仓库里一个人类可读的文本文件版本控制免费获得 多种标记语言Markdown、RDoc 内置AsciiDoc、MediaWiki、Org、ReStructuredText、Textile 装个 gem 即可用✍️ 双通道编辑内置网页编辑器带自动保存 任意本地编辑器提交后即时生效⏪ 完整历史每个页面可查看所有历史版本、对比差异、一键回滚 兼容 GitHub / GitLab Wiki直接 clone 它们的 wiki 仓库本地打开就能看、能改 进阶能力Mermaid/PlantUML 图、KaTeX/MathJax 数学公式、CriticMarkup 批注、BibTeX 引用、RSS 订阅完整特性清单见项目说明文档 README.md。准备工作环境要求一览Gollum 支持 Unix 类系统与 WindowsWindows 下走 JRuby/Java 路线。走最简单的 Ruby 路线你只需要Ruby ≥ 2.6gollum.gemspec 声明的最低版本Git你写 Wiki 时迟早会用到它 完全不想装 Ruby后文还有Docker与Java WAR两条免环境路线可直接跳到 不同场景的部署方案。3个命令搭建你的Git驱动Wiki 命令一安装 Gollum打开终端一条命令装好gem install gollum装完后你会得到gollum命令行工具输入gollum --version应显示 6.x 版本号。命令二初始化一个 Wiki 仓库任何 Git 仓库都可以成为 Wiki。新建一个空仓库即可mkdir my-wiki cd my-wiki git init两个小提示如果你已有 GitHub / GitLab 的 wiki 仓库直接git clone下来就能打开天然兼容想先体验一把也可以 clone 仓库自带的示例 Wiki《指环王》主题test/examples/lotr.git。命令三启动 Gollum进入或指向你的仓库目录执行gollum ./my-wiki看到终端输出类似Sinatra has taken the stage后打开浏览器访问http://localhost:4567你的 Git 驱动 Wiki 就上线了 此时首页可能是空的——这很正常仓库还没有页面。点导航栏的New按钮就能创建第一页当然你也可以直接在仓库里加一个Home.md文件并git commit刷新即可看到。写第一篇 Wiki 页面 ✍️Gollum 的网页编辑器自带自动保存网络中断也不怕丢稿工具栏支持 H1/H2/H3、链接、图片、加粗/斜体、代码块、列表、引用等翻译文案见 lib/gollum/locales/cn.yml内置中文界面。三个新手必须知道的规则文件扩展名决定标记语言notes.md按 Markdown 渲染guide.rdoc按 RDoc 渲染不同页面可以用不同格式页面可以任意分目录docs/api.md会出现在/docs/api路径下目录结构即 Wiki 结构改动 一次 Git 提交无论网页编辑还是本地改文件都会留下一条可追溯、可回滚的历史记录。常用命令行参数速查 ⚙️gollum --help可查看全部选项日常最常用的是这几个完整表格见 README.md参数默认值用途--port4567端口冲突时换端口如gollum ./my-wiki --port 8080--host0.0.0.0个人使用建议--host 127.0.0.1避免局域网暴露--no-edit可编辑只读展示模式适合对外分享 Wiki--refmain或master指定服务的 Git 分支--bare—仓库是裸仓库bare时加上--math—启用数学公式渲染katex或mathjax--critic-markup—启用 CriticMarkup 批注--static生产环境开启使用预编译静态资源安全提醒默认--host 0.0.0.0意味着局域网内任何人可访问并可编辑你的 Wiki。个人使用请显式加--host 127.0.0.1。不想写命令行参数也可以用配置文件config.rb 用于扩展自定义行为如注册自定义标记语言config.ru 则用于以 Rack 应用方式启动、调整启动行为。不同场景的部署方案方案ADocker 一键部署推荐新手不需要装 Ruby一条命令搞定。Dockerfile 基于ruby:3.3-alpine构建docker-run.sh 会自动为/wiki卷git init并启动 Gollumdocker run -d -p 4567:4567 -v /宿主机/路径/my-wiki:/wiki gollumwiki/gollum方案BJava WAR适合 Windows / 无 Ruby 环境☕Gollum 的发行版中包含gollum.war只要有 Java 就能跑java -jar gollum.war -S gollum /绝对路径/my-wiki注意WAR 方式下参数务必传绝对路径。方案C作为系统服务常驻适合团队服务器项目自带各发行版的服务定义可直接部署为开机自启服务systemdcontrib/systemd/gollum.serviceOpenRCcontrib/openrc/init.d/gollumSysVinitcontrib/sysv-debian/init.d/gollum方案D从源码运行适合贡献者️想魔改 Gollum 本身按 CONTRIBUTING.md 的流程git clone https://gitcode.com/gh_mirrors/go/gollum cd gollum bundle install bundle exec bin/gollum /path/to/my-wiki应用主逻辑位于 lib/gollum/app.rb页面视图在 lib/gollum/views/方便你按需扩展。常见问题 FAQQ1端口 4567 被占用了换端口即可gollum ./my-wiki --port 8080然后访问对应新地址。Q2只想展示不希望别人编辑加--no-edit参数启动编辑入口会被禁用。Q3development和production有什么区别由环境变量APP_ENV控制development下每次请求都重载应用便于调试production下只加载一次性能更好。Q4为什么我提交了新页面Wiki 里看不到确认 Gollum 指向的分支正确可用--ref指定以及页面文件扩展名是否为受支持的标记语言如.md、.rdoc。Q5能把 GitHub/GitLab 的 Wiki 搬过来吗可以这正是 Gollum 的设计目标之一——clone 它们的 wiki 仓库gollum一下即可本地浏览与编辑数据完全留在自己的 Git 仓库里。写在最后回顾一下搭建 Gollum Wiki 其实就 3 个命令gem install gollum—— 安装git init—— 准备仓库gollum ./my-wiki—— 启动打开 http://localhost:4567从此你的团队文档、学习笔记、产品手册都可以以纯 Git 文本的形式沉淀下来可搜索、可回滚、可 diff还能随时换到 Gollum 里在线协作。快去创建你的第一页吧【免费下载链接】gollumA simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.项目地址: https://gitcode.com/gh_mirrors/go/gollum创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考