OpenSource-Hub
G

gollum

14.3k stars·開発ツール·SHA-256 チェックサム確認済み

一个基于 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 文件部署。

トラブルシューティング & FAQ (1)

トラブル対応
なぜGollumは私のコードブロック内の山括弧をマクロとしてレンダリングするのでしょうか?また、どうすれば修正できますか?

Gollumは、山括弧を含むインラインコードブロック(例:<address>[;<options>])をGollumのマクロとして誤解釈する可能性があります。これを防ぐには、コードブロックをトリプルバッククォートで囲んだ独立した行に配置します:


[<device>][=<mac-address>]:<address>[;<options>]

これにより、Gollumがその内容をマクロとして解析するのを防ぎます。Dockerイメージを使用している場合、gemの変更は不要です。これはフォーマットの回避策です。

参照 Issue #2173

タグ

wikigitmarkdowndocumentationversion-controlruby

はじめ方

1

インストーラをダウンロード

上のボタンをクリックして、お使いのシステム用のインストーラをダウンロード

2

ソフトウェアをインストール

ダウンロードしたインストーラをダブルクリックし、指示に従ってください

3

步骤 1:确保已安装 Ruby(推荐 2.5+)或 Docker/Java(选择一种方式)

4

步骤 2:安装 Gollum:gem install gollum(Ruby 方式)或 docker pull gollumwiki/gollum

5

步骤 3:进入一个已初始化的 Git 仓库目录,运行 gollum .

インストールガイド
  1. 步骤 1:确保已安装 Ruby(推荐 2.5+)或 Docker/Java(选择一种方式)
  2. 步骤 2:安装 Gollum:gem install gollum(Ruby 方式)或 docker pull gollumwiki/gollum
  3. 步骤 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 文件即可。

追加の依存関係なし

ダウンロード後すぐに使用可能。追加のランタイムは不要です。

プロジェクト情報
ライセンスMIT
最終更新2026-06-26 07:15:15
GitHub リポジトリ公式サイト

問題が発生?以下のFAQを確認

1 FAQ

類似プロジェクト