机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

gollum - 基于 Git 的 Wiki

Gollum 是一个基于 Git 构建的简单 Wiki 系统。Gollum Wiki 只是一个具有特定性质的 git 仓库：

• Gollum 仓库的内容是可由人编辑的文本或标记文件。
• 页面可以按照你选择的任何方式组织到目录中。
• 其他内容也可以包括在内，例如图片、PDF 以及页面的页眉/页脚。
• 咕噜 页面：
  • 可以用各种标记语言编写。
  • 可以使用您喜欢的编辑器进行编辑（提交后更改将可见），也可以使用内置的网页界面进行编辑。
  • 可以在所有版本中显示，可恢复等。
• Gollum 力求与 GitHub 和 GitLab 的 wikis 兼容。
  • 只需克隆你的 GitHub/GitLab wiki，然后在本地查看和编辑它！
• Gollum 支持高级功能，如：
  • 使用 Mermaid 或 PlantUML 的图表
  • BibTeX 和引用支持
  • 使用 CriticMarkup 的注释
  • 数学 通过 KaTeX 或 MathJax
  • 宏
  • 重定向
  • RSS 订阅 最新更改
  • ...以及 更多

请参阅 wiki 获取详细文档，以及 Gollum 功能的 截图。

系统要求

Gollum 可以在类 Unix 系统和 Windows 上运行。

Gollum 可以使用“普通”Ruby (MRI) 或 JRuby（Java 虚拟机上的 Ruby）运行。在 Windows 上，Gollum 只能使用 JRuby 运行（无论是从源代码，还是 预编译）。

在 MRI 上，Gollum 使用 rugged git 库，而在 JRuby/Java 上则使用 rjgit 和 JGit 库。更多信息请参见 这里。

安装

作为一个 Ruby Gem

Ruby 最好通过 RVM 或选择的包管理器安装。然后只需:

gem install gollum

各个系统的安装示例可以在这里查看。

通过 Docker

有关如何通过 Docker 运行 Gollum 的说明，请参见这里。

作为 Web 应用程序资源（Java）

Gollum 的最新版本将始终包含一个可下载的 gollum.war 文件，可在任何具有可用 Java 安装的系统上直接执行：

java -jar gollum.war -S gollum <your-gollum-arguments-here>

在使用 .war 时，请务必将 绝对路径 传递给您的 Gollum 参数。

标记

Gollum 允许在不同的 wiki 页面上使用不同的标记语言。目前它支持以下标记：

• Markdown（有关 Markdown 变体的更多信息，请参见下文）
• RDoc

您可以通过安装其他渲染器（任何由 github-markup 支持的渲染器）轻松启用对其他标记的支持：

• AsciiDoc -- gem install asciidoctor
• 克里奥尔语 -- gem install creole
• MediaWiki -- gem install wikicloth
• Org -- gem install org-ruby
• Pod -- 需要 Perl >= 5.10（perl 命令必须在命令行中可用）
  • 较低版本应从 CPAN 安装 Pod::Simple。
• ReStructuredText -- 需要 python >= 3
  • 请注意，Gollum 还需要你为 Python 安装 docutils
• 纺织品 -- gem install RedCloth

Markdown 变体

默认情况下，Gollum 搭配 kramdown gem 来渲染 Markdown。然而，您可以使用任何 github-markup 支持的 Markdown 渲染器。这包括通过 commonmarker gem 对 CommonMark 的支持。列表中安装的第一个渲染器将被使用（例如，如果安装了 github/markdown，则 redcarpet 将不会被使用）。只需 gem install 您选择的渲染器。

有关如何使用自定义渲染 gem 并设置自定义选项的说明，请见此处。

运行 Gollum

命令行快速入门

1. 运行：gollum /path/to/wiki，其中 /path/to/wiki 是已初始化的 Git 仓库。
2. 在浏览器中打开 http://localhost:4567。

从源代码运行

1. git clone https://github.com/gollum/gollum
2. cd gollum
3. bundle install（根据您的 Ruby 设置可能需要 sudo）
4. bundle exec bin/gollum
5. 在浏览器中打开 http://localhost:4567。

使用 Rack 运行

Gollum 还可以与任何 兼容 Rack 的 Web 服务器 一起运行。更多信息请见此处。

与身份验证服务器一起运行

Gollum 还可以与 CAS（中央身份验证服务）SSO（单点登录）服务器一起运行。经过一些调整，这可以为 Gollum 添加基本用户支持。要查看示例和说明，请访问此处。

作为服务运行

Gollum 也可以作为服务运行。更多信息请见此处。

环境

Gollum 主要使用环境变量 APP_ENV 来控制底层 Sinatra 应用的行为：

• development – 在每次请求时重新加载应用
• production – 仅加载应用一次

配置

Gollum 提供了如下列出的命令行选项。请注意，还有一些额外的“次要”选项可以调整 Gollum 的行为，这些选项没有命令行参数，但可以在 config.rb 中配置。

命令行选项

配置文件

当使用 --config 选项时，Gollum 的某些内部部分可以被自定义。这在我们的维基中用于某些用户级别的更改，其中 自定义支持的标记 可能最为突出。

有关 config.rb 中可配置设置的文档，请参见 这里。

所有提到的更改和选项都适用于 Gollum 的配置文件（config.rb）和 Rack 的配置文件（config.ru）。

贡献

请考虑提供帮助！有关如何提交问题以及如何开始修改 gollum 的信息，请参阅 CONTRIBUTING.md。